diff --git a/docs/user/unattended/reference/index.md b/docs/user/unattended/reference/index.md new file mode 100644 index 0000000..942418d --- /dev/null +++ b/docs/user/unattended/reference/index.md @@ -0,0 +1,213 @@ +# README + +## Top-level Schemas + +* [Config](./storage.md "Config model") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json` + +* [Config](./storage-1.md "Storage config") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json` + +* [Profile](./profile.md "Profile definition for automated installation") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json` + +## Other Schemas + +### Objects + +* [Bonding configuration](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond` + +* [Bootloader settings](./profile-properties-bootloader-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader` + +* [First user settings](./profile-properties-first-user-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user` + +* [Hostname settings](./profile-properties-hostname-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname` + +* [IEEE 802.1x (EAP) settings](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x` + +* [Localization settings](./profile-properties-localization-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization` + +* [Match settings](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md "Identifies the network interface to apply the connection settings to") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match` + +* [Network settings](./profile-properties-network-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network` + +* [Product to install](./profile-properties-product-to-install.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product` + +* [Root authentication settings](./profile-properties-root-authentication-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root` + +* [Search condition](./storage-1-defs-advancedsearch-properties-search-condition.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition` + +* [Size range](./storage-1-defs-size-anyof-size-range.md "Size range") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/2` + +* [Software settings](./profile-properties-software-settings.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software` + +* [Untitled object in Config](./storage-1-defs-encryptionluks1-properties-luks1.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1` + +* [Untitled object in Config](./storage-1-defs-encryptionluks2-properties-luks2.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2` + +* [Untitled object in Config](./storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2` + +* [Untitled object in Config](./storage-1-defs-encryptiontpm-properties-tpmfde.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde` + +* [Untitled object in Config](./storage-1-defs-filesystemtypebtrfs-properties-btrfs.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs` + +* [Untitled object in Config](./storage-1-defs-advancedpartitionsgenerator-properties-generate.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate` + +* [Untitled object in Config](./storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate` + +* [Untitled object in Config](./storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate` + +* [Untitled object in Config](./storage-1-defs-boot.md "Allows configuring boot partitions automatically") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot` + +* [Untitled object in Config](./storage-1-defs-formatteddrive.md "Drive without a partition table (e") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive` + +* [Untitled object in Config](./storage-1-defs-partitioneddrive.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive` + +* [Untitled object in Config](./storage-1-defs-simplevolumesgenerator.md "Automatically creates the default or mandatory volumes configured by the selected product") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator` + +* [Untitled object in Config](./storage-1-defs-advancedpartitionsgenerator.md "Creates the default or mandatory partitions configured by the selected product") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator` + +* [Untitled object in Config](./storage-1-defs-regularpartition.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition` + +* [Untitled object in Config](./storage-1-defs-partitiontodelete.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete` + +* [Untitled object in Config](./storage-1-defs-partitiontodeleteifneeded.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded` + +* [Untitled object in Config](./storage-1-defs-volumegroup.md "LVM volume group") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup` + +* [Untitled object in Config](./storage-1-defs-simplephysicalvolumesgenerator.md "Automatically creates the needed physical volumes in the indicated devices") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator` + +* [Untitled object in Config](./storage-1-defs-advancedphysicalvolumesgenerator.md "Automatically creates the needed physical volumes in the indicated devices") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator` + +* [Untitled object in Config](./storage-1-defs-advancedlogicalvolumesgenerator.md "Automatically creates the default or mandatory logical volumes configured by the selected product") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator` + +* [Untitled object in Config](./storage-1-defs-logicalvolume.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume` + +* [Untitled object in Config](./storage-1-defs-thinpoollogicalvolume.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume` + +* [Untitled object in Config](./storage-1-defs-thinlogicalvolume.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume` + +* [Untitled object in Config](./storage-1-defs-advancedsearch.md "Advanced options for searching devices") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch` + +* [Untitled object in Config](./storage-1-defs-encryptionluks1.md "LUKS1 encryption") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1` + +* [Untitled object in Config](./storage-1-defs-encryptionluks2.md "LUKS2 encryption") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2` + +* [Untitled object in Config](./storage-1-defs-encryptionpervasiveluks2.md "LUKS2 pervasive encryption") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2` + +* [Untitled object in Config](./storage-1-defs-encryptiontpm.md "TPM-Based Full Disk Encrytion") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM` + +* [Untitled object in Config](./storage-1-defs-filesystem.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem` + +* [Untitled object in Config](./storage-1-defs-filesystemtypebtrfs.md "Btrfs file system") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs` + +* [Untitled object in Config](./storage-defs-boot.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot` + +* [Untitled object in Config](./storage-defs-bootdevice.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice` + +* [Untitled object in Config](./storage-defs-encryption.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption` + +* [Untitled object in Config](./storage-defs-drive.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive` + +* [Untitled object in Config](./storage-defs-partition.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition` + +* [Untitled object in Config](./storage-defs-volumegroup.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup` + +* [Untitled object in Config](./storage-defs-logicalvolume.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume` + +* [Untitled object in Config](./storage-defs-filesystem.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem` + +* [Untitled object in Config](./storage-defs-size.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size` + +* [Untitled object in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items` + +* [Untitled object in Profile](./profile-properties-legacy-autoyast-storage-settings-items.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/legacyAutoyastStorage/items` + +* [User-defined file to deploy](./profile-defs-user-defined-file-to-deploy.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file` + +* [User-defined installation script that runs after the installation finishes](./profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript` + +* [User-defined installation script that runs after the partitioning finishes](./profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning` + +* [User-defined installation script that runs before the installation starts](./profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript` + +* [User-defined installation script that runs during the first boot of the target system, once the installation is finished](./profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript` + +* [User-defined installation scripts](./profile-properties-user-defined-installation-scripts.md "User-defined scripts to run at different points of the installation") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts` + +* [Wireless configuration](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless` + +### Arrays + +* [Init scripts](./profile-properties-user-defined-installation-scripts-properties-init-scripts.md "User-defined scripts to run booting the installed system") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/init` + +* [Legacy AutoYaST storage settings](./profile-properties-legacy-autoyast-storage-settings.md "Accepts all options of the AutoYaST partitioning section (i") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/legacyAutoyastStorage` + +* [List of packages to install](./profile-properties-software-settings-properties-list-of-packages-to-install.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/packages` + +* [List of patterns to install](./profile-properties-software-settings-properties-list-of-patterns-to-install.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/patterns` + +* [Network connections to be defined](./profile-properties-network-settings-properties-network-connections-to-be-defined.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections` + +* [Post-installation scripts](./profile-properties-user-defined-installation-scripts-properties-post-installation-scripts.md "User-defined scripts to run after the installation finishes") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/post` + +* [Post-partitioning scripts](./profile-properties-user-defined-installation-scripts-properties-post-partitioning-scripts.md "User-defined scripts to run after the partitioning finishes") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/postPartitioning` + +* [Pre-installation scripts](./profile-properties-user-defined-installation-scripts-properties-pre-installation-scripts.md "User-defined scripts to run before the installation starts") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/pre` + +* [Size tuple](./storage-1-defs-size-anyof-size-tuple.md "Lower size limit and optionally upper size limit") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/1` + +* [Untitled array in Config](./storage-1-properties-drives.md "Drives (disks, BIOS RAIDs and multipath devices)") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/drives` + +* [Untitled array in Config](./storage-1-defs-filesystem-properties-mkfsoptions.md "Options for creating the file system") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mkfsOptions` + +* [Untitled array in Config](./storage-1-defs-filesystem-properties-mountoptions.md "Options to add to the fourth field of fstab") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountOptions` + +* [Untitled array in Config](./storage-1-defs-partitioneddrive-properties-partitions.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/partitions` + +* [Untitled array in Config](./storage-1-properties-volumegroups.md "LVM volume groups") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/volumeGroups` + +* [Untitled array in Config](./storage-1-defs-volumegroup-properties-physicalvolumes.md "Devices to use as physical volumes") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/physicalVolumes` + +* [Untitled array in Config](./storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator/properties/generate` + +* [Untitled array in Config](./storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate/properties/targetDevices` + +* [Untitled array in Config](./storage-1-defs-volumegroup-properties-logicalvolumes.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/logicalVolumes` + +* [Untitled array in Config](./storage-properties-drives.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/drives` + +* [Untitled array in Config](./storage-defs-drive-properties-partitions.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/partitions` + +* [Untitled array in Config](./storage-properties-volumegroups.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/volumeGroups` + +* [Untitled array in Config](./storage-defs-volumegroup-properties-targetdevices.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/targetDevices` + +* [Untitled array in Config](./storage-defs-volumegroup-properties-logicalvolumes.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/logicalVolumes` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/addresses` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/nameservers` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/dns_searchlist` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/groupAlgorithms` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pairwiseAlgorithms` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/wpaProtocolVersions` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/ports` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/kernel` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/interface` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/driver` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/path` + +* [Untitled array in Profile](./profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap.md) – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/eap` + +* [User-defined files to deploy](./profile-properties-user-defined-files-to-deploy.md "User-defined files to deploy after installation just before post install scripts") – `https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/files` + +## Version Note + +The schemas linked above follow the JSON Schema Spec version: `https://json-schema.org/draft/2019-09/schema` diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-oneof-0.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-oneof-0.md new file mode 100644 index 0000000..c745c7c --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-oneof-0.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/oneOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-oneof-1.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-oneof-1.md new file mode 100644 index 0000000..d25047f --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-oneof-1.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/oneOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 1 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-destination.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-destination.md new file mode 100644 index 0000000..f58a63f --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-destination.md @@ -0,0 +1,15 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/destination +``` + +path where file should be deployed + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## destination Type + +`string` diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-content.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-content.md new file mode 100644 index 0000000..f185782 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-content.md @@ -0,0 +1,15 @@ +# File content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/content +``` + +File content + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## content Type + +`string` ([File content](profile-defs-user-defined-file-to-deploy-properties-file-content.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md new file mode 100644 index 0000000..4ecc997 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md @@ -0,0 +1,15 @@ +# File owner group Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/group +``` + +Group owning the file on installed system. User has to already exist + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## group Type + +`string` ([File owner group](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md new file mode 100644 index 0000000..45984f6 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md @@ -0,0 +1,15 @@ +# File owner user Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/user +``` + +User owning the file on installed system. User has to already exist + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## user Type + +`string` ([File owner user](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-permissions.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-permissions.md new file mode 100644 index 0000000..8067887 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-permissions.md @@ -0,0 +1,15 @@ +# File permissions Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/permissions +``` + +file permissions on installed system + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## permissions Type + +`string` ([File permissions](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-url.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-url.md new file mode 100644 index 0000000..68f1d0c --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy-properties-file-url.md @@ -0,0 +1,15 @@ +# File URL Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/url +``` + +URL to fetch the file from + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## url Type + +unknown ([File URL](profile-defs-user-defined-file-to-deploy-properties-file-url.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy.md b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy.md new file mode 100644 index 0000000..6feefbf --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-file-to-deploy.md @@ -0,0 +1,140 @@ +# User-defined file to deploy Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## file Type + +`object` ([User-defined file to deploy](profile-defs-user-defined-file-to-deploy.md)) + +one (and only one) of + +* [Untitled undefined type in Profile](profile-defs-user-defined-file-to-deploy-oneof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-file-to-deploy-oneof-1.md "check type definition") + +# file Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [destination](#destination) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-destination.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/destination") | +| [content](#content) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/content") | +| [url](#url) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/url") | +| [permissions](#permissions) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/permissions") | +| [user](#user) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/user") | +| [group](#group) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/group") | + +## destination + +path where file should be deployed + +`destination` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-destination.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/destination") + +### destination Type + +`string` + +## content + +File content + +`content` + +* is optional + +* Type: `string` ([File content](profile-defs-user-defined-file-to-deploy-properties-file-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/content") + +### content Type + +`string` ([File content](profile-defs-user-defined-file-to-deploy-properties-file-content.md)) + +## url + +URL to fetch the file from + +`url` + +* is optional + +* Type: unknown ([File URL](profile-defs-user-defined-file-to-deploy-properties-file-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/url") + +### url Type + +unknown ([File URL](profile-defs-user-defined-file-to-deploy-properties-file-url.md)) + +## permissions + +file permissions on installed system + +`permissions` + +* is optional + +* Type: `string` ([File permissions](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/permissions") + +### permissions Type + +`string` ([File permissions](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md)) + +## user + +User owning the file on installed system. User has to already exist + +`user` + +* is optional + +* Type: `string` ([File owner user](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/user") + +### user Type + +`string` ([File owner user](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md)) + +## group + +Group owning the file on installed system. User has to already exist + +`group` + +* is optional + +* Type: `string` ([File owner group](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/group") + +### group Type + +`string` ([File owner group](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-0.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-0.md new file mode 100644 index 0000000..4ba57a5 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-0.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/oneOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-1.md new file mode 100644 index 0000000..3ead0e0 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-1.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/oneOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 1 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-2.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-2.md new file mode 100644 index 0000000..92fc03c --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-2.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/oneOf/2 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 2 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-name.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-name.md new file mode 100644 index 0000000..b9333a4 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-name.md @@ -0,0 +1,15 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/name +``` + +Script name, to be used as file name + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## name Type + +`string` diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md new file mode 100644 index 0000000..6046d16 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/content +``` + +Script content, starting with the shebang. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md new file mode 100644 index 0000000..2f1eb68 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/body +``` + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :--------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Deprecated | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md new file mode 100644 index 0000000..d2f6ce6 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md @@ -0,0 +1,15 @@ +# Script URL Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/url +``` + +URL to fetch the script from + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md new file mode 100644 index 0000000..8dfc2e0 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md @@ -0,0 +1,15 @@ +# Whether it should run in the installed system using a chroot environment Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/chroot +``` + +whether to chroot to the target system (default: yes) or not + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## chroot Type + +`boolean` ([Whether it should run in the installed system using a chroot environment](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md new file mode 100644 index 0000000..2b1005e --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md @@ -0,0 +1,123 @@ +# User-defined installation script that runs after the installation finishes Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## postScript Type + +`object` ([User-defined installation script that runs after the installation finishes](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md)) + +one (and only one) of + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-1.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-oneof-2.md "check type definition") + +# postScript Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/name") | +| [body](#body) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/body") | +| [content](#content) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/content") | +| [url](#url) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/url") | +| [chroot](#chroot) | `boolean` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/chroot") | + +## name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/name") + +### name Type + +`string` + +## body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/body") + +### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md)) + +## content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/content") + +### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md)) + +## url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/url") + +### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md)) + +## chroot + +whether to chroot to the target system (default: yes) or not + +`chroot` + +* is optional + +* Type: `boolean` ([Whether it should run in the installed system using a chroot environment](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/chroot") + +### chroot Type + +`boolean` ([Whether it should run in the installed system using a chroot environment](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-0.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-0.md new file mode 100644 index 0000000..48efeab --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-0.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/oneOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-1.md new file mode 100644 index 0000000..4a01807 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-1.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/oneOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 1 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-2.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-2.md new file mode 100644 index 0000000..eb957de --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-2.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/oneOf/2 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 2 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-name.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-name.md new file mode 100644 index 0000000..3c24570 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-name.md @@ -0,0 +1,15 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/name +``` + +Script name, to be used as file name + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## name Type + +`string` diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md new file mode 100644 index 0000000..eb108cd --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/content +``` + +Script content, starting with the shebang. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md new file mode 100644 index 0000000..acf2284 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/body +``` + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :--------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Deprecated | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md new file mode 100644 index 0000000..cb1330b --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md @@ -0,0 +1,15 @@ +# Script URL Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/url +``` + +URL to fetch the script from + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md new file mode 100644 index 0000000..f8afad2 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md @@ -0,0 +1,104 @@ +# User-defined installation script that runs after the partitioning finishes Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## postPartitioning Type + +`object` ([User-defined installation script that runs after the partitioning finishes](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md)) + +one (and only one) of + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-1.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-oneof-2.md "check type definition") + +# postPartitioning Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/name") | +| [body](#body) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/body") | +| [content](#content) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/content") | +| [url](#url) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/url") | + +## name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/name") + +### name Type + +`string` + +## body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/body") + +### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md)) + +## content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/content") + +### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md)) + +## url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/url") + +### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-0.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-0.md new file mode 100644 index 0000000..783c3d7 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-0.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/oneOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-1.md new file mode 100644 index 0000000..79aa9c4 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-1.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/oneOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 1 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-2.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-2.md new file mode 100644 index 0000000..bd75517 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-2.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/oneOf/2 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 2 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-name.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-name.md new file mode 100644 index 0000000..b771c69 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-name.md @@ -0,0 +1,15 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/name +``` + +Script name, to be used as file name + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## name Type + +`string` diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md new file mode 100644 index 0000000..8e7efe9 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/content +``` + +Script content, starting with the shebang. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md new file mode 100644 index 0000000..9f365f0 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/body +``` + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :--------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Deprecated | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md new file mode 100644 index 0000000..8524831 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md @@ -0,0 +1,15 @@ +# Script URL Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/url +``` + +URL to fetch the script from + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md new file mode 100644 index 0000000..ba1b863 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md @@ -0,0 +1,104 @@ +# User-defined installation script that runs before the installation starts Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## preScript Type + +`object` ([User-defined installation script that runs before the installation starts](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md)) + +one (and only one) of + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-1.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-oneof-2.md "check type definition") + +# preScript Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [name](#name) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/name") | +| [body](#body) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/body") | +| [content](#content) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/content") | +| [url](#url) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/url") | + +## name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/name") + +### name Type + +`string` + +## body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/body") + +### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md)) + +## content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/content") + +### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md)) + +## url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/url") + +### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-0.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-0.md new file mode 100644 index 0000000..dac7060 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-0.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/oneOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-1.md new file mode 100644 index 0000000..cdf9ef0 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-1.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/oneOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 1 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-2.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-2.md new file mode 100644 index 0000000..11fee59 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-2.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/oneOf/2 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 2 Type + +unknown diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-name.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-name.md new file mode 100644 index 0000000..5da407a --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-name.md @@ -0,0 +1,15 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/name +``` + +Script name, to be used as file name + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## name Type + +`string` diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md new file mode 100644 index 0000000..a5693f1 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/content +``` + +Script content, starting with the shebang. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md new file mode 100644 index 0000000..9f68d0b --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md @@ -0,0 +1,15 @@ +# Script content Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/body +``` + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :--------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Deprecated | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md new file mode 100644 index 0000000..4760844 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md @@ -0,0 +1,15 @@ +# Script URL Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/url +``` + +URL to fetch the script from + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md)) diff --git a/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md new file mode 100644 index 0000000..abccbb3 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md @@ -0,0 +1,104 @@ +# User-defined installation script that runs during the first boot of the target system, once the installation is finished Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## initScript Type + +`object` ([User-defined installation script that runs during the first boot of the target system, once the installation is finished](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md)) + +one (and only one) of + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-1.md "check type definition") + +* [Untitled undefined type in Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-oneof-2.md "check type definition") + +# initScript Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/name") | +| [body](#body) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/body") | +| [content](#content) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/content") | +| [url](#url) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/url") | + +## name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/name") + +### name Type + +`string` + +## body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/body") + +### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md)) + +## content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/content") + +### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md)) + +## url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/url") + +### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md)) diff --git a/docs/user/unattended/reference/profile-defs.md b/docs/user/unattended/reference/profile-defs.md new file mode 100644 index 0000000..1908c47 --- /dev/null +++ b/docs/user/unattended/reference/profile-defs.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## $defs Type + +unknown diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-0.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-0.md new file mode 100644 index 0000000..adff5b0 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-0.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/oneOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-1.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-1.md new file mode 100644 index 0000000..9a883f4 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-1.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/oneOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 1 Type + +unknown diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not-anyof-0.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not-anyof-0.md new file mode 100644 index 0000000..e7217f2 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not-anyof-0.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/oneOf/2/not/anyOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 0 Type + +unknown diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not-anyof-1.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not-anyof-1.md new file mode 100644 index 0000000..fa49cbe --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not-anyof-1.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/oneOf/2/not/anyOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 1 Type + +unknown diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not.md new file mode 100644 index 0000000..8ce7ba8 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2-not.md @@ -0,0 +1,21 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/oneOf/2/not +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## not Type + +merged type ([Details](profile-properties-bootloader-settings-oneof-2-not.md)) + +any of + +* [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-1.md "check type definition") diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2.md new file mode 100644 index 0000000..6f6fd1c --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-oneof-2.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/oneOf/2 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## 2 Type + +merged type ([Details](profile-properties-bootloader-settings-oneof-2.md)) + +not + +* any of + + * [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-0.md "check type definition") + + * [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-1.md "check type definition") diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md new file mode 100644 index 0000000..0ad20f6 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md @@ -0,0 +1,19 @@ +# Specify how long bootloader should wait on menu before going with default entry. Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/properties/timeout +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## timeout Type + +`integer` ([Specify how long bootloader should wait on menu before going with default entry.](profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md)) + +## timeout Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md b/docs/user/unattended/reference/profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md new file mode 100644 index 0000000..3e6e986 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md @@ -0,0 +1,15 @@ +# Specify if bootloader should stop on menu during boot. Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/properties/stopOnBootMenu +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## stopOnBootMenu Type + +`boolean` ([Specify if bootloader should stop on menu during boot.](profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md)) diff --git a/docs/user/unattended/reference/profile-properties-bootloader-settings.md b/docs/user/unattended/reference/profile-properties-bootloader-settings.md new file mode 100644 index 0000000..398ed50 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-bootloader-settings.md @@ -0,0 +1,76 @@ +# Bootloader settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## bootloader Type + +`object` ([Bootloader settings](profile-properties-bootloader-settings.md)) + +one (and only one) of + +* [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-1.md "check type definition") + +* not + + * any of + + * [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-0.md "check type definition") + + * [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-1.md "check type definition") + +# bootloader Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :-------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [stopOnBootMenu](#stoponbootmenu) | `boolean` | Optional | cannot be null | [Profile](profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/properties/stopOnBootMenu") | +| [timeout](#timeout) | `integer` | Optional | cannot be null | [Profile](profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/properties/timeout") | + +## stopOnBootMenu + + + +`stopOnBootMenu` + +* is optional + +* Type: `boolean` ([Specify if bootloader should stop on menu during boot.](profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/properties/stopOnBootMenu") + +### stopOnBootMenu Type + +`boolean` ([Specify if bootloader should stop on menu during boot.](profile-properties-bootloader-settings-properties-specify-if-bootloader-should-stop-on-menu-during-boot.md)) + +## timeout + + + +`timeout` + +* is optional + +* Type: `integer` ([Specify how long bootloader should wait on menu before going with default entry.](profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader/properties/timeout") + +### timeout Type + +`integer` ([Specify how long bootloader should wait on menu before going with default entry.](profile-properties-bootloader-settings-properties-specify-how-long-bootloader-should-wait-on-menu-before-going-with-default-entry.md)) + +### timeout Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/profile-properties-first-user-settings-properties-automatic-user-login.md b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-automatic-user-login.md new file mode 100644 index 0000000..afe19e3 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-automatic-user-login.md @@ -0,0 +1,15 @@ +# Automatic user login Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/autologin +``` + +Whether the user should be automatically logged in (only relevant in desktop systems) + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## autologin Type + +`boolean` ([Automatic user login](profile-properties-first-user-settings-properties-automatic-user-login.md)) diff --git a/docs/user/unattended/reference/profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md new file mode 100644 index 0000000..82636a0 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md @@ -0,0 +1,15 @@ +# Flag for hashed password (true) or plain text password (false or not defined) Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/hashedPassword +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## hashedPassword Type + +`boolean` ([Flag for hashed password (true) or plain text password (false or not defined)](profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md)) diff --git a/docs/user/unattended/reference/profile-properties-first-user-settings-properties-full-name.md b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-full-name.md new file mode 100644 index 0000000..70986b0 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-full-name.md @@ -0,0 +1,21 @@ +# Full name Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/fullName +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## fullName Type + +`string` ([Full name](profile-properties-first-user-settings-properties-full-name.md)) + +## fullName Examples + +```json +"Jane Doe" +``` diff --git a/docs/user/unattended/reference/profile-properties-first-user-settings-properties-user-login-name.md b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-user-login-name.md new file mode 100644 index 0000000..5efc495 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-user-login-name.md @@ -0,0 +1,21 @@ +# User login name Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/userName +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## userName Type + +`string` ([User login name](profile-properties-first-user-settings-properties-user-login-name.md)) + +## userName Examples + +```json +"jane.doe" +``` diff --git a/docs/user/unattended/reference/profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md new file mode 100644 index 0000000..1f86dd8 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md @@ -0,0 +1,21 @@ +# User password (plain text or hashed depending on the "hashedPassword" field) Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/password +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## password Type + +`string` ([User password (plain text or hashed depending on the "hashedPassword" field)](profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md)) + +## password Examples + +```json +"nots3cr3t" +``` diff --git a/docs/user/unattended/reference/profile-properties-first-user-settings.md b/docs/user/unattended/reference/profile-properties-first-user-settings.md new file mode 100644 index 0000000..4a93885 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-first-user-settings.md @@ -0,0 +1,133 @@ +# First user settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## user Type + +`object` ([First user settings](profile-properties-first-user-settings.md)) + +# user Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [fullName](#fullname) | `string` | Required | cannot be null | [Profile](profile-properties-first-user-settings-properties-full-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/fullName") | +| [userName](#username) | `string` | Required | cannot be null | [Profile](profile-properties-first-user-settings-properties-user-login-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/userName") | +| [password](#password) | `string` | Required | cannot be null | [Profile](profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/password") | +| [hashedPassword](#hashedpassword) | `boolean` | Optional | cannot be null | [Profile](profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/hashedPassword") | +| [autologin](#autologin) | `boolean` | Optional | cannot be null | [Profile](profile-properties-first-user-settings-properties-automatic-user-login.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/autologin") | + +## fullName + + + +`fullName` + +* is required + +* Type: `string` ([Full name](profile-properties-first-user-settings-properties-full-name.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-first-user-settings-properties-full-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/fullName") + +### fullName Type + +`string` ([Full name](profile-properties-first-user-settings-properties-full-name.md)) + +### fullName Examples + +```json +"Jane Doe" +``` + +## userName + + + +`userName` + +* is required + +* Type: `string` ([User login name](profile-properties-first-user-settings-properties-user-login-name.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-first-user-settings-properties-user-login-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/userName") + +### userName Type + +`string` ([User login name](profile-properties-first-user-settings-properties-user-login-name.md)) + +### userName Examples + +```json +"jane.doe" +``` + +## password + + + +`password` + +* is required + +* Type: `string` ([User password (plain text or hashed depending on the "hashedPassword" field)](profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/password") + +### password Type + +`string` ([User password (plain text or hashed depending on the "hashedPassword" field)](profile-properties-first-user-settings-properties-user-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md)) + +### password Examples + +```json +"nots3cr3t" +``` + +## hashedPassword + + + +`hashedPassword` + +* is optional + +* Type: `boolean` ([Flag for hashed password (true) or plain text password (false or not defined)](profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/hashedPassword") + +### hashedPassword Type + +`boolean` ([Flag for hashed password (true) or plain text password (false or not defined)](profile-properties-first-user-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md)) + +## autologin + +Whether the user should be automatically logged in (only relevant in desktop systems) + +`autologin` + +* is optional + +* Type: `boolean` ([Automatic user login](profile-properties-first-user-settings-properties-automatic-user-login.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-first-user-settings-properties-automatic-user-login.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user/properties/autologin") + +### autologin Type + +`boolean` ([Automatic user login](profile-properties-first-user-settings-properties-automatic-user-login.md)) diff --git a/docs/user/unattended/reference/profile-properties-hostname-settings-properties-system-static-hostname.md b/docs/user/unattended/reference/profile-properties-hostname-settings-properties-system-static-hostname.md new file mode 100644 index 0000000..1fd9637 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-hostname-settings-properties-system-static-hostname.md @@ -0,0 +1,15 @@ +# System static hostname. Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname/properties/static +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## static Type + +`string` ([System static hostname.](profile-properties-hostname-settings-properties-system-static-hostname.md)) diff --git a/docs/user/unattended/reference/profile-properties-hostname-settings-properties-system-transient-hostname.md b/docs/user/unattended/reference/profile-properties-hostname-settings-properties-system-transient-hostname.md new file mode 100644 index 0000000..e9a7938 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-hostname-settings-properties-system-transient-hostname.md @@ -0,0 +1,15 @@ +# System transient hostname. Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname/properties/transient +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## transient Type + +`string` ([System transient hostname.](profile-properties-hostname-settings-properties-system-transient-hostname.md)) diff --git a/docs/user/unattended/reference/profile-properties-hostname-settings.md b/docs/user/unattended/reference/profile-properties-hostname-settings.md new file mode 100644 index 0000000..a94a496 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-hostname-settings.md @@ -0,0 +1,58 @@ +# Hostname settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## hostname Type + +`object` ([Hostname settings](profile-properties-hostname-settings.md)) + +# hostname Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [static](#static) | `string` | Optional | cannot be null | [Profile](profile-properties-hostname-settings-properties-system-static-hostname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname/properties/static") | +| [transient](#transient) | `string` | Optional | cannot be null | [Profile](profile-properties-hostname-settings-properties-system-transient-hostname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname/properties/transient") | + +## static + + + +`static` + +* is optional + +* Type: `string` ([System static hostname.](profile-properties-hostname-settings-properties-system-static-hostname.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-hostname-settings-properties-system-static-hostname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname/properties/static") + +### static Type + +`string` ([System static hostname.](profile-properties-hostname-settings-properties-system-static-hostname.md)) + +## transient + + + +`transient` + +* is optional + +* Type: `string` ([System transient hostname.](profile-properties-hostname-settings-properties-system-transient-hostname.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-hostname-settings-properties-system-transient-hostname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname/properties/transient") + +### transient Type + +`string` ([System transient hostname.](profile-properties-hostname-settings-properties-system-transient-hostname.md)) diff --git a/docs/user/unattended/reference/profile-properties-legacy-autoyast-storage-settings-items.md b/docs/user/unattended/reference/profile-properties-legacy-autoyast-storage-settings-items.md new file mode 100644 index 0000000..df6274a --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-legacy-autoyast-storage-settings-items.md @@ -0,0 +1,15 @@ +# Untitled object in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/legacyAutoyastStorage/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`object` ([Details](profile-properties-legacy-autoyast-storage-settings-items.md)) diff --git a/docs/user/unattended/reference/profile-properties-legacy-autoyast-storage-settings.md b/docs/user/unattended/reference/profile-properties-legacy-autoyast-storage-settings.md new file mode 100644 index 0000000..5e3d519 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-legacy-autoyast-storage-settings.md @@ -0,0 +1,15 @@ +# Legacy AutoYaST storage settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/legacyAutoyastStorage +``` + +Accepts all options of the AutoYaST partitioning section (i.e., XML to JSON) + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## legacyAutoyastStorage Type + +`object[]` ([Details](profile-properties-legacy-autoyast-storage-settings-items.md)) diff --git a/docs/user/unattended/reference/profile-properties-localization-settings-properties-keyboard-layout-id.md b/docs/user/unattended/reference/profile-properties-localization-settings-properties-keyboard-layout-id.md new file mode 100644 index 0000000..12cfaba --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-localization-settings-properties-keyboard-layout-id.md @@ -0,0 +1,15 @@ +# Keyboard layout ID Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/keyboard +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## keyboard Type + +`string` ([Keyboard layout ID](profile-properties-localization-settings-properties-keyboard-layout-id.md)) diff --git a/docs/user/unattended/reference/profile-properties-localization-settings-properties-system-language-id.md b/docs/user/unattended/reference/profile-properties-localization-settings-properties-system-language-id.md new file mode 100644 index 0000000..ef272f1 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-localization-settings-properties-system-language-id.md @@ -0,0 +1,25 @@ +# System language ID Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/language +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## language Type + +`string` ([System language ID](profile-properties-localization-settings-properties-system-language-id.md)) + +## language Examples + +```json +"en_US.UTF-8" +``` + +```json +"en_US" +``` diff --git a/docs/user/unattended/reference/profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md b/docs/user/unattended/reference/profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md new file mode 100644 index 0000000..7194cc1 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md @@ -0,0 +1,21 @@ +# Time zone identifier such as 'Europe/Berlin' Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/timezone +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## timezone Type + +`string` ([Time zone identifier such as 'Europe/Berlin'](profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md)) + +## timezone Examples + +```json +"Europe/Berlin" +``` diff --git a/docs/user/unattended/reference/profile-properties-localization-settings.md b/docs/user/unattended/reference/profile-properties-localization-settings.md new file mode 100644 index 0000000..a7359ef --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-localization-settings.md @@ -0,0 +1,93 @@ +# Localization settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## localization Type + +`object` ([Localization settings](profile-properties-localization-settings.md)) + +# localization Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [language](#language) | `string` | Optional | cannot be null | [Profile](profile-properties-localization-settings-properties-system-language-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/language") | +| [keyboard](#keyboard) | `string` | Optional | cannot be null | [Profile](profile-properties-localization-settings-properties-keyboard-layout-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/keyboard") | +| [timezone](#timezone) | `string` | Optional | cannot be null | [Profile](profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/timezone") | + +## language + + + +`language` + +* is optional + +* Type: `string` ([System language ID](profile-properties-localization-settings-properties-system-language-id.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-localization-settings-properties-system-language-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/language") + +### language Type + +`string` ([System language ID](profile-properties-localization-settings-properties-system-language-id.md)) + +### language Examples + +```json +"en_US.UTF-8" +``` + +```json +"en_US" +``` + +## keyboard + + + +`keyboard` + +* is optional + +* Type: `string` ([Keyboard layout ID](profile-properties-localization-settings-properties-keyboard-layout-id.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-localization-settings-properties-keyboard-layout-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/keyboard") + +### keyboard Type + +`string` ([Keyboard layout ID](profile-properties-localization-settings-properties-keyboard-layout-id.md)) + +## timezone + + + +`timezone` + +* is optional + +* Type: `string` ([Time zone identifier such as 'Europe/Berlin'](profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization/properties/timezone") + +### timezone Type + +`string` ([Time zone identifier such as 'Europe/Berlin'](profile-properties-localization-settings-properties-time-zone-identifier-such-as-europeberlin.md)) + +### timezone Examples + +```json +"Europe/Berlin" +``` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses-connection-addresses.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses-connection-addresses.md new file mode 100644 index 0000000..8304321 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses-connection-addresses.md @@ -0,0 +1,15 @@ +# Connection addresses Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/addresses/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([Connection addresses](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses-connection-addresses.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses.md new file mode 100644 index 0000000..b9ba325 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/addresses +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## addresses Type + +`string[]` ([Connection addresses](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses-connection-addresses.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md new file mode 100644 index 0000000..e5f460d --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md @@ -0,0 +1,15 @@ +# Auto-connected Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/autoconnect +``` + +Whether the connection should be automatically connected + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## autoconnect Type + +`boolean` ([Auto-connected](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-mode.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-mode.md new file mode 100644 index 0000000..4604a94 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-mode.md @@ -0,0 +1,29 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/mode +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## mode Type + +`string` + +## mode Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---------------- | :---------- | +| `"balance-rr"` | | +| `"active-backup"` | | +| `"balance-xor"` | | +| `"broadcast"` | | +| `"802.3ad"` | | +| `"balance-tlb"` | | +| `"balance-alb"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-options.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-options.md new file mode 100644 index 0000000..60c327f --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-options.md @@ -0,0 +1,15 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/options +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## options Type + +`string` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports-a-list-of-the-interfaces-or-connections-to-be-bonded.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports-a-list-of-the-interfaces-or-connections-to-be-bonded.md new file mode 100644 index 0000000..8874fd5 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports-a-list-of-the-interfaces-or-connections-to-be-bonded.md @@ -0,0 +1,15 @@ +# A list of the interfaces or connections to be bonded Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/ports/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of the interfaces or connections to be bonded](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports-a-list-of-the-interfaces-or-connections-to-be-bonded.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports.md new file mode 100644 index 0000000..61fcb01 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/ports +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## ports Type + +`string[]` ([A list of the interfaces or connections to be bonded](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports-a-list-of-the-interfaces-or-connections-to-be-bonded.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md new file mode 100644 index 0000000..0257874 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md @@ -0,0 +1,91 @@ +# Bonding configuration Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## bond Type + +`object` ([Bonding configuration](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md)) + +# bond Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [mode](#mode) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-mode.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/mode") | +| [options](#options) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-options.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/options") | +| [ports](#ports) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/ports") | + +## mode + + + +`mode` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-mode.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/mode") + +### mode Type + +`string` + +### mode Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---------------- | :---------- | +| `"balance-rr"` | | +| `"active-backup"` | | +| `"balance-xor"` | | +| `"broadcast"` | | +| `"802.3ad"` | | +| `"balance-tlb"` | | +| `"balance-alb"` | | + +## options + + + +`options` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-options.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/options") + +### options Type + +`string` + +## ports + + + +`ports` + +* is optional + +* Type: `string[]` ([A list of the interfaces or connections to be bonded](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports-a-list-of-the-interfaces-or-connections-to-be-bonded.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond/properties/ports") + +### ports Type + +`string[]` ([A list of the interfaces or connections to be bonded](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration-properties-ports-a-list-of-the-interfaces-or-connections-to-be-bonded.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md new file mode 100644 index 0000000..3c4b482 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md @@ -0,0 +1,21 @@ +# Connection gateway address Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/gateway6 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## gateway6 Type + +`string` ([Connection gateway address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md)) + +## gateway6 Examples + +```json +"::ffff:c0a8:7a01" +``` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md new file mode 100644 index 0000000..7dd2308 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md @@ -0,0 +1,21 @@ +# Connection gateway address Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/gateway4 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## gateway4 Type + +`string` ([Connection gateway address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md)) + +## gateway4 Examples + +```json +"192.168.122.1" +``` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md new file mode 100644 index 0000000..1ee73be --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md @@ -0,0 +1,15 @@ +# Connection ID Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/id +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## id Type + +`string` ([Connection ID](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md new file mode 100644 index 0000000..5e61264 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md @@ -0,0 +1,25 @@ +# Connection status Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/status +``` + +The status of the connection + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## status Type + +`string` ([Connection status](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md)) + +## status Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---------- | :---------- | +| `"up"` | | +| `"down"` | | +| `"removed"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md new file mode 100644 index 0000000..e5abaac --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md @@ -0,0 +1,15 @@ +# Custom MAC address Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/macAddress +``` + +Can also be 'preserve', 'permanent', 'random' or 'stable'. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## macAddress Type + +`string` ([Custom MAC address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist-items.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist-items.md new file mode 100644 index 0000000..d20b41a --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist-items.md @@ -0,0 +1,15 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/dns_searchlist/items +``` + +DNS search domains + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist.md new file mode 100644 index 0000000..5722f68 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/dns_searchlist +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## dns\_searchlist Type + +`string[]` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md new file mode 100644 index 0000000..b15259e --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md @@ -0,0 +1,15 @@ +# Anonymous identity string for EAP authentication methods Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/anonymousIdentity +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## anonymousIdentity Type + +`string` ([Anonymous identity string for EAP authentication methods](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap-list-of-eap-methods-used.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap-list-of-eap-methods-used.md new file mode 100644 index 0000000..dddc3c9 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap-list-of-eap-methods-used.md @@ -0,0 +1,29 @@ +# List of EAP methods used Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/eap/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([List of EAP methods used](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap-list-of-eap-methods-used.md)) + +## items Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------- | :---------- | +| `"leap"` | | +| `"md5"` | | +| `"tls"` | | +| `"peap"` | | +| `"ttls"` | | +| `"pwd"` | | +| `"fast"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap.md new file mode 100644 index 0000000..c79e6f3 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/eap +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## eap Type + +`string[]` ([List of EAP methods used](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap-list-of-eap-methods-used.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md new file mode 100644 index 0000000..a9788ee --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md @@ -0,0 +1,15 @@ +# Force the use of the new PEAP label during key derivation Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/peapLabel +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## peapLabel Type + +`boolean` ([Force the use of the new PEAP label during key derivation](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md new file mode 100644 index 0000000..399cb9f --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md @@ -0,0 +1,15 @@ +# Identity string, often for example the user's login name Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/identity +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## identity Type + +`string` ([Identity string, often for example the user's login name](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md new file mode 100644 index 0000000..0c3c1a2 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md @@ -0,0 +1,15 @@ +# Password string for CA certificate if it is encrypted Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/caCertPassword +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## caCertPassword Type + +`string` ([Password string for CA certificate if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md new file mode 100644 index 0000000..dc64335 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md @@ -0,0 +1,15 @@ +# Password string for client certificate if it is encrypted Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/clientCertPassword +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## clientCertPassword Type + +`string` ([Password string for client certificate if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md new file mode 100644 index 0000000..19d7078 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md @@ -0,0 +1,15 @@ +# Password string for private key if it is encrypted Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/privateKeyPassword +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## privateKeyPassword Type + +`string` ([Password string for private key if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md new file mode 100644 index 0000000..e961c61 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md @@ -0,0 +1,15 @@ +# Password string used for EAP authentication Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/password +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## password Type + +`string` ([Password string used for EAP authentication](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md new file mode 100644 index 0000000..9a47386 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md @@ -0,0 +1,15 @@ +# Path to CA certificate Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/caCert +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## caCert Type + +`string` ([Path to CA certificate](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md new file mode 100644 index 0000000..e8aee00 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md @@ -0,0 +1,15 @@ +# Path to client certificate Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/clientCert +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## clientCert Type + +`string` ([Path to client certificate](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md new file mode 100644 index 0000000..3eab395 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md @@ -0,0 +1,15 @@ +# Path to private key Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/privateKey +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## privateKey Type + +`string` ([Path to private key](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md new file mode 100644 index 0000000..8028170 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md @@ -0,0 +1,30 @@ +# Phase 2 inner auth method Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/phase2Auth +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## phase2Auth Type + +`string` ([Phase 2 inner auth method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md)) + +## phase2Auth Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"pap"` | | +| `"chap"` | | +| `"mschap"` | | +| `"mschapv2"` | | +| `"gtc"` | | +| `"otp"` | | +| `"md5"` | | +| `"tls"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md new file mode 100644 index 0000000..12758bf --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md @@ -0,0 +1,24 @@ +# Which PEAP version is used when PEAP is set as the EAP method in the 'eap' property Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/peapVersion +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## peapVersion Type + +`string` ([Which PEAP version is used when PEAP is set as the EAP method in the 'eap' property](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md)) + +## peapVersion Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---- | :---------- | +| `"0"` | | +| `"1"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md new file mode 100644 index 0000000..6213dd7 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md @@ -0,0 +1,291 @@ +# IEEE 802.1x (EAP) settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## ieee-8021x Type + +`object` ([IEEE 802.1x (EAP) settings](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md)) + +# ieee-8021x Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------------------- | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [eap](#eap) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/eap") | +| [phase2Auth](#phase2auth) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/phase2Auth") | +| [identity](#identity) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/identity") | +| [password](#password) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/password") | +| [caCert](#cacert) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/caCert") | +| [caCertPassword](#cacertpassword) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/caCertPassword") | +| [clientCert](#clientcert) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/clientCert") | +| [clientCertPassword](#clientcertpassword) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/clientCertPassword") | +| [privateKey](#privatekey) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/privateKey") | +| [privateKeyPassword](#privatekeypassword) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/privateKeyPassword") | +| [anonymousIdentity](#anonymousidentity) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/anonymousIdentity") | +| [peapVersion](#peapversion) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/peapVersion") | +| [peapLabel](#peaplabel) | `boolean` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/peapLabel") | + +## eap + + + +`eap` + +* is optional + +* Type: `string[]` ([List of EAP methods used](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap-list-of-eap-methods-used.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/eap") + +### eap Type + +`string[]` ([List of EAP methods used](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-eap-list-of-eap-methods-used.md)) + +## phase2Auth + + + +`phase2Auth` + +* is optional + +* Type: `string` ([Phase 2 inner auth method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/phase2Auth") + +### phase2Auth Type + +`string` ([Phase 2 inner auth method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-phase-2-inner-auth-method.md)) + +### phase2Auth Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"pap"` | | +| `"chap"` | | +| `"mschap"` | | +| `"mschapv2"` | | +| `"gtc"` | | +| `"otp"` | | +| `"md5"` | | +| `"tls"` | | + +## identity + + + +`identity` + +* is optional + +* Type: `string` ([Identity string, often for example the user's login name](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/identity") + +### identity Type + +`string` ([Identity string, often for example the user's login name](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-identity-string-often-for-example-the-users-login-name.md)) + +## password + + + +`password` + +* is optional + +* Type: `string` ([Password string used for EAP authentication](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/password") + +### password Type + +`string` ([Password string used for EAP authentication](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-used-for-eap-authentication.md)) + +## caCert + + + +`caCert` + +* is optional + +* Type: `string` ([Path to CA certificate](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/caCert") + +### caCert Type + +`string` ([Path to CA certificate](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-ca-certificate.md)) + +## caCertPassword + + + +`caCertPassword` + +* is optional + +* Type: `string` ([Password string for CA certificate if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/caCertPassword") + +### caCertPassword Type + +`string` ([Password string for CA certificate if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-ca-certificate-if-it-is-encrypted.md)) + +## clientCert + + + +`clientCert` + +* is optional + +* Type: `string` ([Path to client certificate](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/clientCert") + +### clientCert Type + +`string` ([Path to client certificate](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-client-certificate.md)) + +## clientCertPassword + + + +`clientCertPassword` + +* is optional + +* Type: `string` ([Password string for client certificate if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/clientCertPassword") + +### clientCertPassword Type + +`string` ([Password string for client certificate if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-client-certificate-if-it-is-encrypted.md)) + +## privateKey + + + +`privateKey` + +* is optional + +* Type: `string` ([Path to private key](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/privateKey") + +### privateKey Type + +`string` ([Path to private key](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-path-to-private-key.md)) + +## privateKeyPassword + + + +`privateKeyPassword` + +* is optional + +* Type: `string` ([Password string for private key if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/privateKeyPassword") + +### privateKeyPassword Type + +`string` ([Password string for private key if it is encrypted](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-password-string-for-private-key-if-it-is-encrypted.md)) + +## anonymousIdentity + + + +`anonymousIdentity` + +* is optional + +* Type: `string` ([Anonymous identity string for EAP authentication methods](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/anonymousIdentity") + +### anonymousIdentity Type + +`string` ([Anonymous identity string for EAP authentication methods](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-anonymous-identity-string-for-eap-authentication-methods.md)) + +## peapVersion + + + +`peapVersion` + +* is optional + +* Type: `string` ([Which PEAP version is used when PEAP is set as the EAP method in the 'eap' property](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/peapVersion") + +### peapVersion Type + +`string` ([Which PEAP version is used when PEAP is set as the EAP method in the 'eap' property](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-which-peap-version-is-used-when-peap-is-set-as-the-eap-method-in-the-eap-property.md)) + +### peapVersion Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---- | :---------- | +| `"0"` | | +| `"1"` | | + +## peapLabel + + + +`peapLabel` + +* is optional + +* Type: `boolean` ([Force the use of the new PEAP label during key derivation](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x/properties/peapLabel") + +### peapLabel Type + +`boolean` ([Force the use of the new PEAP label during key derivation](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings-properties-force-the-use-of-the-new-peap-label-during-key-derivation.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ignoreautodns.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ignoreautodns.md new file mode 100644 index 0000000..853bdfe --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ignoreautodns.md @@ -0,0 +1,15 @@ +# Untitled boolean in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ignoreAutoDns +``` + +Whether DNS options provided via DHCP are used or not + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## ignoreAutoDns Type + +`boolean` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md new file mode 100644 index 0000000..993974b --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md @@ -0,0 +1,26 @@ +# IPv4 configuration method Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/method4 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## method4 Type + +`string` ([IPv4 configuration method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md)) + +## method4 Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------- | :---------- | +| `"auto"` | | +| `"manual"` | | +| `"link-local"` | | +| `"disabled"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md new file mode 100644 index 0000000..8d10aa0 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md @@ -0,0 +1,26 @@ +# IPv6 configuration method Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/method6 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## method6 Type + +`string` ([IPv6 configuration method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md)) + +## method6 Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------- | :---------- | +| `"auto"` | | +| `"manual"` | | +| `"link-local"` | | +| `"disabled"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver-a-list-of-driver-names-to-match.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver-a-list-of-driver-names-to-match.md new file mode 100644 index 0000000..a8419e0 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver-a-list-of-driver-names-to-match.md @@ -0,0 +1,15 @@ +# A list of driver names to match Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/driver/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of driver names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver-a-list-of-driver-names-to-match.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver.md new file mode 100644 index 0000000..a86f92b --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/driver +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## driver Type + +`string[]` ([A list of driver names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver-a-list-of-driver-names-to-match.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface-a-list-of-interface-names-to-match.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface-a-list-of-interface-names-to-match.md new file mode 100644 index 0000000..900f4c3 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface-a-list-of-interface-names-to-match.md @@ -0,0 +1,15 @@ +# A list of interface names to match Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/interface/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of interface names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface-a-list-of-interface-names-to-match.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface.md new file mode 100644 index 0000000..31de15e --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/interface +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## interface Type + +`string[]` ([A list of interface names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface-a-list-of-interface-names-to-match.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel-a-list-of-kernel-command-line-arguments-to-match.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel-a-list-of-kernel-command-line-arguments-to-match.md new file mode 100644 index 0000000..bfddc8e --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel-a-list-of-kernel-command-line-arguments-to-match.md @@ -0,0 +1,15 @@ +# A list of kernel command line arguments to match Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/kernel/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of kernel command line arguments to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel-a-list-of-kernel-command-line-arguments-to-match.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel.md new file mode 100644 index 0000000..428320c --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/kernel +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## kernel Type + +`string[]` ([A list of kernel command line arguments to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel-a-list-of-kernel-command-line-arguments-to-match.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path-a-list-of-paths-to-match-against-the-id_path-udev-property-of-devices.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path-a-list-of-paths-to-match-against-the-id_path-udev-property-of-devices.md new file mode 100644 index 0000000..d0d020c --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path-a-list-of-paths-to-match-against-the-id_path-udev-property-of-devices.md @@ -0,0 +1,15 @@ +# A list of paths to match against the ID\_PATH udev property of devices Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/path/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of paths to match against the ID\_PATH udev property of devices](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path-a-list-of-paths-to-match-against-the-id_path-udev-property-of-devices.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path.md new file mode 100644 index 0000000..1242c1c --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/path +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## path Type + +`string[]` ([A list of paths to match against the ID\_PATH udev property of devices](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path-a-list-of-paths-to-match-against-the-id_path-udev-property-of-devices.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md new file mode 100644 index 0000000..5dfd213 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md @@ -0,0 +1,96 @@ +# Match settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match +``` + +Identifies the network interface to apply the connection settings to + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## match Type + +`object` ([Match settings](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md)) + +# match Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [kernel](#kernel) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/kernel") | +| [interface](#interface) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/interface") | +| [driver](#driver) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/driver") | +| [path](#path) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/path") | + +## kernel + + + +`kernel` + +* is optional + +* Type: `string[]` ([A list of kernel command line arguments to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel-a-list-of-kernel-command-line-arguments-to-match.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/kernel") + +### kernel Type + +`string[]` ([A list of kernel command line arguments to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-kernel-a-list-of-kernel-command-line-arguments-to-match.md)) + +## interface + + + +`interface` + +* is optional + +* Type: `string[]` ([A list of interface names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface-a-list-of-interface-names-to-match.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/interface") + +### interface Type + +`string[]` ([A list of interface names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-interface-a-list-of-interface-names-to-match.md)) + +## driver + + + +`driver` + +* is optional + +* Type: `string[]` ([A list of driver names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver-a-list-of-driver-names-to-match.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/driver") + +### driver Type + +`string[]` ([A list of driver names to match](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-driver-a-list-of-driver-names-to-match.md)) + +## path + + + +`path` + +* is optional + +* Type: `string[]` ([A list of paths to match against the ID\_PATH udev property of devices](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path-a-list-of-paths-to-match-against-the-id_path-udev-property-of-devices.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match/properties/path") + +### path Type + +`string[]` ([A list of paths to match against the ID\_PATH udev property of devices](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings-properties-path-a-list-of-paths-to-match-against-the-id_path-udev-property-of-devices.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-mtu.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-mtu.md new file mode 100644 index 0000000..3a1619d --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-mtu.md @@ -0,0 +1,19 @@ +# Untitled integer in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/mtu +``` + +Connection MTU + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## mtu Type + +`integer` + +## mtu Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers-nameservers.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers-nameservers.md new file mode 100644 index 0000000..7be33cd --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers-nameservers.md @@ -0,0 +1,15 @@ +# Nameservers Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/nameservers/items +``` + +IPv4 and/or IPv6 are allowed. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([Nameservers](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers-nameservers.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers.md new file mode 100644 index 0000000..dcaf483 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/nameservers +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## nameservers Type + +`string[]` ([Nameservers](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers-nameservers.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md new file mode 100644 index 0000000..7137954 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md @@ -0,0 +1,15 @@ +# The name of the network interface bound to this connection Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/interface +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## interface Type + +`string` ([The name of the network interface bound to this connection](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md new file mode 100644 index 0000000..98dca21 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md @@ -0,0 +1,24 @@ +# Frequency band of the wireless network Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/band +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## band Type + +`string` ([Frequency band of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md)) + +## band Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----- | :---------- | +| `"a"` | | +| `"bg"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms-a-list-of-groupbroadcast-encryption-algorithms.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms-a-list-of-groupbroadcast-encryption-algorithms.md new file mode 100644 index 0000000..f94a5b3 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms-a-list-of-groupbroadcast-encryption-algorithms.md @@ -0,0 +1,26 @@ +# A list of group/broadcast encryption algorithms Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/groupAlgorithms/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of group/broadcast encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms-a-list-of-groupbroadcast-encryption-algorithms.md)) + +## items Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"wep40"` | | +| `"wep104"` | | +| `"tkip"` | | +| `"ccmp"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms.md new file mode 100644 index 0000000..c050e0d --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/groupAlgorithms +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## groupAlgorithms Type + +`string[]` ([A list of group/broadcast encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms-a-list-of-groupbroadcast-encryption-algorithms.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md new file mode 100644 index 0000000..4768df7 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md @@ -0,0 +1,15 @@ +# Indicates that the wireless network is not broadcasting its SSID Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/hidden +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## hidden Type + +`boolean` ([Indicates that the wireless network is not broadcasting its SSID](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md new file mode 100644 index 0000000..9af236f --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md @@ -0,0 +1,15 @@ +# Indicates whether Protected Management Frames must be enabled for the connection Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pmf +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## pmf Type + +`integer` ([Indicates whether Protected Management Frames must be enabled for the connection](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md new file mode 100644 index 0000000..00ae0be --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md @@ -0,0 +1,15 @@ +# Only allow connection to this mac address Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/bssid +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## bssid Type + +`string` ([Only allow connection to this mac address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms-a-list-of-pairwise-encryption-algorithms.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms-a-list-of-pairwise-encryption-algorithms.md new file mode 100644 index 0000000..c6dda95 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms-a-list-of-pairwise-encryption-algorithms.md @@ -0,0 +1,24 @@ +# A list of pairwise encryption algorithms Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pairwiseAlgorithms/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of pairwise encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms-a-list-of-pairwise-encryption-algorithms.md)) + +## items Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------- | :---------- | +| `"tkip"` | | +| `"ccmp"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms.md new file mode 100644 index 0000000..0ad0a3d --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pairwiseAlgorithms +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## pairwiseAlgorithms Type + +`string[]` ([A list of pairwise encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms-a-list-of-pairwise-encryption-algorithms.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md new file mode 100644 index 0000000..7f6a88b --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md @@ -0,0 +1,15 @@ +# Password of the wireless network Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/password +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## password Type + +`string` ([Password of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md new file mode 100644 index 0000000..ac028dd --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md @@ -0,0 +1,29 @@ +# Security method/key management Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/security +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## security Type + +`string` ([Security method/key management](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md)) + +## security Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---------------------- | :---------- | +| `"none"` | | +| `"owe"` | | +| `"ieee8021x"` | | +| `"wpa-psk"` | | +| `"sae"` | | +| `"wpa-eap"` | | +| `"wpa-eap-suite-b-192"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md new file mode 100644 index 0000000..f14f81e --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md @@ -0,0 +1,15 @@ +# SSID of the wireless network Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/ssid +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## ssid Type + +`string` ([SSID of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md new file mode 100644 index 0000000..18aa62a --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md @@ -0,0 +1,19 @@ +# Wireless channel of the wireless network Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/channel +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## channel Type + +`integer` ([Wireless channel of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md)) + +## channel Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md new file mode 100644 index 0000000..7145730 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md @@ -0,0 +1,26 @@ +# Wireless network mode Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/mode +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## mode Type + +`string` ([Wireless network mode](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md)) + +## mode Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------------- | :---------- | +| `"infrastructure"` | | +| `"adhoc"` | | +| `"mesh"` | | +| `"ap"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions-a-list-of-allowed-wpa-protocol-versions.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions-a-list-of-allowed-wpa-protocol-versions.md new file mode 100644 index 0000000..b4dd515 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions-a-list-of-allowed-wpa-protocol-versions.md @@ -0,0 +1,24 @@ +# A list of allowed WPA protocol versions Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/wpaProtocolVersions/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` ([A list of allowed WPA protocol versions](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions-a-list-of-allowed-wpa-protocol-versions.md)) + +## items Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------ | :---------- | +| `"wpa"` | | +| `"rsn"` | | diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions.md new file mode 100644 index 0000000..dbf8221 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions.md @@ -0,0 +1,15 @@ +# Untitled array in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/wpaProtocolVersions +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## wpaProtocolVersions Type + +`string[]` ([A list of allowed WPA protocol versions](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions-a-list-of-allowed-wpa-protocol-versions.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md new file mode 100644 index 0000000..5e10ea5 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md @@ -0,0 +1,286 @@ +# Wireless configuration Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## wireless Type + +`object` ([Wireless configuration](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md)) + +# wireless Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------------------ | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [password](#password) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/password") | +| [security](#security) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/security") | +| [ssid](#ssid) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/ssid") | +| [mode](#mode) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/mode") | +| [hidden](#hidden) | `boolean` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/hidden") | +| [band](#band) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/band") | +| [channel](#channel) | `integer` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/channel") | +| [bssid](#bssid) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/bssid") | +| [groupAlgorithms](#groupalgorithms) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/groupAlgorithms") | +| [pairwiseAlgorithms](#pairwisealgorithms) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pairwiseAlgorithms") | +| [wpaProtocolVersions](#wpaprotocolversions) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/wpaProtocolVersions") | +| [pmf](#pmf) | `integer` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pmf") | + +## password + + + +`password` + +* is optional + +* Type: `string` ([Password of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/password") + +### password Type + +`string` ([Password of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-password-of-the-wireless-network.md)) + +## security + + + +`security` + +* is optional + +* Type: `string` ([Security method/key management](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/security") + +### security Type + +`string` ([Security method/key management](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-security-methodkey-management.md)) + +### security Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---------------------- | :---------- | +| `"none"` | | +| `"owe"` | | +| `"ieee8021x"` | | +| `"wpa-psk"` | | +| `"sae"` | | +| `"wpa-eap"` | | +| `"wpa-eap-suite-b-192"` | | + +## ssid + + + +`ssid` + +* is optional + +* Type: `string` ([SSID of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/ssid") + +### ssid Type + +`string` ([SSID of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-ssid-of-the-wireless-network.md)) + +## mode + + + +`mode` + +* is optional + +* Type: `string` ([Wireless network mode](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/mode") + +### mode Type + +`string` ([Wireless network mode](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-network-mode.md)) + +### mode Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------------- | :---------- | +| `"infrastructure"` | | +| `"adhoc"` | | +| `"mesh"` | | +| `"ap"` | | + +## hidden + + + +`hidden` + +* is optional + +* Type: `boolean` ([Indicates that the wireless network is not broadcasting its SSID](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/hidden") + +### hidden Type + +`boolean` ([Indicates that the wireless network is not broadcasting its SSID](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-that-the-wireless-network-is-not-broadcasting-its-ssid.md)) + +## band + + + +`band` + +* is optional + +* Type: `string` ([Frequency band of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/band") + +### band Type + +`string` ([Frequency band of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-frequency-band-of-the-wireless-network.md)) + +### band Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----- | :---------- | +| `"a"` | | +| `"bg"` | | + +## channel + + + +`channel` + +* is optional + +* Type: `integer` ([Wireless channel of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/channel") + +### channel Type + +`integer` ([Wireless channel of the wireless network](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wireless-channel-of-the-wireless-network.md)) + +### channel Constraints + +**minimum**: the value of this number must greater than or equal to: `0` + +## bssid + + + +`bssid` + +* is optional + +* Type: `string` ([Only allow connection to this mac address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/bssid") + +### bssid Type + +`string` ([Only allow connection to this mac address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-only-allow-connection-to-this-mac-address.md)) + +## groupAlgorithms + + + +`groupAlgorithms` + +* is optional + +* Type: `string[]` ([A list of group/broadcast encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms-a-list-of-groupbroadcast-encryption-algorithms.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/groupAlgorithms") + +### groupAlgorithms Type + +`string[]` ([A list of group/broadcast encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-groupalgorithms-a-list-of-groupbroadcast-encryption-algorithms.md)) + +## pairwiseAlgorithms + + + +`pairwiseAlgorithms` + +* is optional + +* Type: `string[]` ([A list of pairwise encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms-a-list-of-pairwise-encryption-algorithms.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pairwiseAlgorithms") + +### pairwiseAlgorithms Type + +`string[]` ([A list of pairwise encryption algorithms](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-pairwisealgorithms-a-list-of-pairwise-encryption-algorithms.md)) + +## wpaProtocolVersions + + + +`wpaProtocolVersions` + +* is optional + +* Type: `string[]` ([A list of allowed WPA protocol versions](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions-a-list-of-allowed-wpa-protocol-versions.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/wpaProtocolVersions") + +### wpaProtocolVersions Type + +`string[]` ([A list of allowed WPA protocol versions](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-wpaprotocolversions-a-list-of-allowed-wpa-protocol-versions.md)) + +## pmf + + + +`pmf` + +* is optional + +* Type: `integer` ([Indicates whether Protected Management Frames must be enabled for the connection](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless/properties/pmf") + +### pmf Type + +`integer` ([Indicates whether Protected Management Frames must be enabled for the connection](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration-properties-indicates-whether-protected-management-frames-must-be-enabled-for-the-connection.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items.md new file mode 100644 index 0000000..bd3439d --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined-items.md @@ -0,0 +1,410 @@ +# Untitled object in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`object` ([Details](profile-properties-network-settings-properties-network-connections-to-be-defined-items.md)) + +# items Properties + +| Property | Type | Required | Nullable | Defined by | +| :--------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [id](#id) | `string` | Required | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/id") | +| [interface](#interface) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/interface") | +| [macAddress](#macaddress) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/macAddress") | +| [mtu](#mtu) | `integer` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-mtu.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/mtu") | +| [method4](#method4) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/method4") | +| [method6](#method6) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/method6") | +| [gateway4](#gateway4) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/gateway4") | +| [gateway6](#gateway6) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/gateway6") | +| [addresses](#addresses) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/addresses") | +| [nameservers](#nameservers) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/nameservers") | +| [dns\_searchlist](#dns_searchlist) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/dns_searchlist") | +| [ignoreAutoDns](#ignoreautodns) | `boolean` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ignoreautodns.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ignoreAutoDns") | +| [status](#status) | `string` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/status") | +| [autoconnect](#autoconnect) | `boolean` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/autoconnect") | +| [wireless](#wireless) | `object` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless") | +| [bond](#bond) | `object` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond") | +| [match](#match) | `object` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match") | +| [ieee-8021x](#ieee-8021x) | `object` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x") | + +## id + + + +`id` + +* is required + +* Type: `string` ([Connection ID](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/id") + +### id Type + +`string` ([Connection ID](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-id.md)) + +## interface + + + +`interface` + +* is optional + +* Type: `string` ([The name of the network interface bound to this connection](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/interface") + +### interface Type + +`string` ([The name of the network interface bound to this connection](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-the-name-of-the-network-interface-bound-to-this-connection.md)) + +## macAddress + +Can also be 'preserve', 'permanent', 'random' or 'stable'. + +`macAddress` + +* is optional + +* Type: `string` ([Custom MAC address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/macAddress") + +### macAddress Type + +`string` ([Custom MAC address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-custom-mac-address.md)) + +## mtu + +Connection MTU + +`mtu` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-mtu.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/mtu") + +### mtu Type + +`integer` + +### mtu Constraints + +**minimum**: the value of this number must greater than or equal to: `0` + +## method4 + + + +`method4` + +* is optional + +* Type: `string` ([IPv4 configuration method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/method4") + +### method4 Type + +`string` ([IPv4 configuration method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv4-configuration-method.md)) + +### method4 Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------- | :---------- | +| `"auto"` | | +| `"manual"` | | +| `"link-local"` | | +| `"disabled"` | | + +## method6 + + + +`method6` + +* is optional + +* Type: `string` ([IPv6 configuration method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/method6") + +### method6 Type + +`string` ([IPv6 configuration method](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ipv6-configuration-method.md)) + +### method6 Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------- | :---------- | +| `"auto"` | | +| `"manual"` | | +| `"link-local"` | | +| `"disabled"` | | + +## gateway4 + + + +`gateway4` + +* is optional + +* Type: `string` ([Connection gateway address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/gateway4") + +### gateway4 Type + +`string` ([Connection gateway address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address.md)) + +### gateway4 Examples + +```json +"192.168.122.1" +``` + +## gateway6 + + + +`gateway6` + +* is optional + +* Type: `string` ([Connection gateway address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/gateway6") + +### gateway6 Type + +`string` ([Connection gateway address](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-gateway-address-1.md)) + +### gateway6 Examples + +```json +"::ffff:c0a8:7a01" +``` + +## addresses + + + +`addresses` + +* is optional + +* Type: `string[]` ([Connection addresses](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses-connection-addresses.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/addresses") + +### addresses Type + +`string[]` ([Connection addresses](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-addresses-connection-addresses.md)) + +## nameservers + + + +`nameservers` + +* is optional + +* Type: `string[]` ([Nameservers](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers-nameservers.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/nameservers") + +### nameservers Type + +`string[]` ([Nameservers](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-nameservers-nameservers.md)) + +## dns\_searchlist + + + +`dns_searchlist` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-dns_searchlist.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/dns_searchlist") + +### dns\_searchlist Type + +`string[]` + +## ignoreAutoDns + +Whether DNS options provided via DHCP are used or not + +`ignoreAutoDns` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ignoreautodns.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ignoreAutoDns") + +### ignoreAutoDns Type + +`boolean` + +## status + +The status of the connection + +`status` + +* is optional + +* Type: `string` ([Connection status](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/status") + +### status Type + +`string` ([Connection status](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-connection-status.md)) + +### status Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :---------- | :---------- | +| `"up"` | | +| `"down"` | | +| `"removed"` | | + +## autoconnect + +Whether the connection should be automatically connected + +`autoconnect` + +* is optional + +* Type: `boolean` ([Auto-connected](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/autoconnect") + +### autoconnect Type + +`boolean` ([Auto-connected](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-auto-connected.md)) + +## wireless + + + +`wireless` + +* is optional + +* Type: `object` ([Wireless configuration](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/wireless") + +### wireless Type + +`object` ([Wireless configuration](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-wireless-configuration.md)) + +## bond + + + +`bond` + +* is optional + +* Type: `object` ([Bonding configuration](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/bond") + +### bond Type + +`object` ([Bonding configuration](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-bonding-configuration.md)) + +## match + +Identifies the network interface to apply the connection settings to + +`match` + +* is optional + +* Type: `object` ([Match settings](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/match") + +### match Type + +`object` ([Match settings](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-match-settings.md)) + +## ieee-8021x + + + +`ieee-8021x` + +* is optional + +* Type: `object` ([IEEE 802.1x (EAP) settings](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections/items/properties/ieee-8021x") + +### ieee-8021x Type + +`object` ([IEEE 802.1x (EAP) settings](profile-properties-network-settings-properties-network-connections-to-be-defined-items-properties-ieee-8021x-eap-settings.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined.md b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined.md new file mode 100644 index 0000000..cb98bb9 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings-properties-network-connections-to-be-defined.md @@ -0,0 +1,15 @@ +# Network connections to be defined Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## connections Type + +`object[]` ([Details](profile-properties-network-settings-properties-network-connections-to-be-defined-items.md)) diff --git a/docs/user/unattended/reference/profile-properties-network-settings.md b/docs/user/unattended/reference/profile-properties-network-settings.md new file mode 100644 index 0000000..a79b2ae --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-network-settings.md @@ -0,0 +1,39 @@ +# Network settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## network Type + +`object` ([Network settings](profile-properties-network-settings.md)) + +# network Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [connections](#connections) | `array` | Optional | cannot be null | [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections") | + +## connections + + + +`connections` + +* is optional + +* Type: `object[]` ([Details](profile-properties-network-settings-properties-network-connections-to-be-defined-items.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings-properties-network-connections-to-be-defined.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network/properties/connections") + +### connections Type + +`object[]` ([Details](profile-properties-network-settings-properties-network-connections-to-be-defined-items.md)) diff --git a/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-identifier.md b/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-identifier.md new file mode 100644 index 0000000..7b5eb25 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-identifier.md @@ -0,0 +1,15 @@ +# Product identifier Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/id +``` + +The id field from a products.d/foo.yaml file + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## id Type + +`string` ([Product identifier](profile-properties-product-to-install-properties-product-identifier.md)) diff --git a/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-registration-code.md b/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-registration-code.md new file mode 100644 index 0000000..042a063 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-registration-code.md @@ -0,0 +1,15 @@ +# Product registration code Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/registrationCode +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## registrationCode Type + +`string` ([Product registration code](profile-properties-product-to-install-properties-product-registration-code.md)) diff --git a/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-registration-email.md b/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-registration-email.md new file mode 100644 index 0000000..e1a0a68 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-product-to-install-properties-product-registration-email.md @@ -0,0 +1,15 @@ +# Product registration email Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/registrationEmail +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## registrationEmail Type + +`string` ([Product registration email](profile-properties-product-to-install-properties-product-registration-email.md)) diff --git a/docs/user/unattended/reference/profile-properties-product-to-install.md b/docs/user/unattended/reference/profile-properties-product-to-install.md new file mode 100644 index 0000000..165ce38 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-product-to-install.md @@ -0,0 +1,77 @@ +# Product to install Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## product Type + +`object` ([Product to install](profile-properties-product-to-install.md)) + +# product Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [id](#id) | `string` | Required | cannot be null | [Profile](profile-properties-product-to-install-properties-product-identifier.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/id") | +| [registrationCode](#registrationcode) | `string` | Optional | cannot be null | [Profile](profile-properties-product-to-install-properties-product-registration-code.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/registrationCode") | +| [registrationEmail](#registrationemail) | `string` | Optional | cannot be null | [Profile](profile-properties-product-to-install-properties-product-registration-email.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/registrationEmail") | + +## id + +The id field from a products.d/foo.yaml file + +`id` + +* is required + +* Type: `string` ([Product identifier](profile-properties-product-to-install-properties-product-identifier.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-product-to-install-properties-product-identifier.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/id") + +### id Type + +`string` ([Product identifier](profile-properties-product-to-install-properties-product-identifier.md)) + +## registrationCode + + + +`registrationCode` + +* is optional + +* Type: `string` ([Product registration code](profile-properties-product-to-install-properties-product-registration-code.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-product-to-install-properties-product-registration-code.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/registrationCode") + +### registrationCode Type + +`string` ([Product registration code](profile-properties-product-to-install-properties-product-registration-code.md)) + +## registrationEmail + + + +`registrationEmail` + +* is optional + +* Type: `string` ([Product registration email](profile-properties-product-to-install-properties-product-registration-email.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-product-to-install-properties-product-registration-email.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product/properties/registrationEmail") + +### registrationEmail Type + +`string` ([Product registration email](profile-properties-product-to-install-properties-product-registration-email.md)) diff --git a/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md b/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md new file mode 100644 index 0000000..0b31a82 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md @@ -0,0 +1,15 @@ +# Flag for hashed password (true) or plain text password (false or not defined) Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/hashedPassword +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## hashedPassword Type + +`boolean` ([Flag for hashed password (true) or plain text password (false or not defined)](profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md)) diff --git a/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md b/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md new file mode 100644 index 0000000..2aa2ee4 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md @@ -0,0 +1,15 @@ +# Root password (plain text or hashed depending on the "hashedPassword" field) Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/password +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## password Type + +`string` ([Root password (plain text or hashed depending on the "hashedPassword" field)](profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md)) diff --git a/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-ssh-public-key.md b/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-ssh-public-key.md new file mode 100644 index 0000000..e333d72 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-root-authentication-settings-properties-ssh-public-key.md @@ -0,0 +1,15 @@ +# SSH public key Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/sshPublicKey +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## sshPublicKey Type + +`string` ([SSH public key](profile-properties-root-authentication-settings-properties-ssh-public-key.md)) diff --git a/docs/user/unattended/reference/profile-properties-root-authentication-settings.md b/docs/user/unattended/reference/profile-properties-root-authentication-settings.md new file mode 100644 index 0000000..281cb3f --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-root-authentication-settings.md @@ -0,0 +1,77 @@ +# Root authentication settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## root Type + +`object` ([Root authentication settings](profile-properties-root-authentication-settings.md)) + +# root Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [password](#password) | `string` | Optional | cannot be null | [Profile](profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/password") | +| [hashedPassword](#hashedpassword) | `boolean` | Optional | cannot be null | [Profile](profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/hashedPassword") | +| [sshPublicKey](#sshpublickey) | `string` | Optional | cannot be null | [Profile](profile-properties-root-authentication-settings-properties-ssh-public-key.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/sshPublicKey") | + +## password + + + +`password` + +* is optional + +* Type: `string` ([Root password (plain text or hashed depending on the "hashedPassword" field)](profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/password") + +### password Type + +`string` ([Root password (plain text or hashed depending on the "hashedPassword" field)](profile-properties-root-authentication-settings-properties-root-password-plain-text-or-hashed-depending-on-the-hashedpassword-field.md)) + +## hashedPassword + + + +`hashedPassword` + +* is optional + +* Type: `boolean` ([Flag for hashed password (true) or plain text password (false or not defined)](profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/hashedPassword") + +### hashedPassword Type + +`boolean` ([Flag for hashed password (true) or plain text password (false or not defined)](profile-properties-root-authentication-settings-properties-flag-for-hashed-password-true-or-plain-text-password-false-or-not-defined.md)) + +## sshPublicKey + + + +`sshPublicKey` + +* is optional + +* Type: `string` ([SSH public key](profile-properties-root-authentication-settings-properties-ssh-public-key.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-root-authentication-settings-properties-ssh-public-key.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root/properties/sshPublicKey") + +### sshPublicKey Type + +`string` ([SSH public key](profile-properties-root-authentication-settings-properties-ssh-public-key.md)) diff --git a/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-packages-to-install-items.md b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-packages-to-install-items.md new file mode 100644 index 0000000..94e91bf --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-packages-to-install-items.md @@ -0,0 +1,21 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/packages/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` + +## items Examples + +```json +"vim" +``` diff --git a/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-packages-to-install.md b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-packages-to-install.md new file mode 100644 index 0000000..33a9511 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-packages-to-install.md @@ -0,0 +1,15 @@ +# List of packages to install Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/packages +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## packages Type + +`string[]` diff --git a/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-patterns-to-install-items.md b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-patterns-to-install-items.md new file mode 100644 index 0000000..c2e943e --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-patterns-to-install-items.md @@ -0,0 +1,21 @@ +# Untitled string in Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/patterns/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## items Type + +`string` + +## items Examples + +```json +"minimal_base" +``` diff --git a/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-patterns-to-install.md b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-patterns-to-install.md new file mode 100644 index 0000000..e61b4d0 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-software-settings-properties-list-of-patterns-to-install.md @@ -0,0 +1,15 @@ +# List of patterns to install Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/patterns +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## patterns Type + +`string[]` diff --git a/docs/user/unattended/reference/profile-properties-software-settings.md b/docs/user/unattended/reference/profile-properties-software-settings.md new file mode 100644 index 0000000..9cd69c7 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-software-settings.md @@ -0,0 +1,58 @@ +# Software settings Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## software Type + +`object` ([Software settings](profile-properties-software-settings.md)) + +# software Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [patterns](#patterns) | `array` | Optional | cannot be null | [Profile](profile-properties-software-settings-properties-list-of-patterns-to-install.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/patterns") | +| [packages](#packages) | `array` | Optional | cannot be null | [Profile](profile-properties-software-settings-properties-list-of-packages-to-install.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/packages") | + +## patterns + + + +`patterns` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Profile](profile-properties-software-settings-properties-list-of-patterns-to-install.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/patterns") + +### patterns Type + +`string[]` + +## packages + + + +`packages` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Profile](profile-properties-software-settings-properties-list-of-packages-to-install.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software/properties/packages") + +### packages Type + +`string[]` diff --git a/docs/user/unattended/reference/profile-properties-user-defined-files-to-deploy.md b/docs/user/unattended/reference/profile-properties-user-defined-files-to-deploy.md new file mode 100644 index 0000000..6a41264 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-user-defined-files-to-deploy.md @@ -0,0 +1,15 @@ +# User-defined files to deploy Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/files +``` + +User-defined files to deploy after installation just before post install scripts + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## files Type + +`object[]` ([User-defined file to deploy](profile-defs-user-defined-file-to-deploy.md)) diff --git a/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-init-scripts.md b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-init-scripts.md new file mode 100644 index 0000000..812e6a1 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-init-scripts.md @@ -0,0 +1,15 @@ +# Init scripts Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/init +``` + +User-defined scripts to run booting the installed system + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## init Type + +`object[]` ([User-defined installation script that runs during the first boot of the target system, once the installation is finished](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md)) diff --git a/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-post-installation-scripts.md b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-post-installation-scripts.md new file mode 100644 index 0000000..4e7a49f --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-post-installation-scripts.md @@ -0,0 +1,15 @@ +# Post-installation scripts Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/post +``` + +User-defined scripts to run after the installation finishes + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## post Type + +`object[]` ([User-defined installation script that runs after the installation finishes](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md)) diff --git a/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-post-partitioning-scripts.md b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-post-partitioning-scripts.md new file mode 100644 index 0000000..3a6987a --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-post-partitioning-scripts.md @@ -0,0 +1,15 @@ +# Post-partitioning scripts Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/postPartitioning +``` + +User-defined scripts to run after the partitioning finishes + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## postPartitioning Type + +`object[]` ([User-defined installation script that runs after the partitioning finishes](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md)) diff --git a/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-pre-installation-scripts.md b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-pre-installation-scripts.md new file mode 100644 index 0000000..81994e5 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts-properties-pre-installation-scripts.md @@ -0,0 +1,15 @@ +# Pre-installation scripts Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/pre +``` + +User-defined scripts to run before the installation starts + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## pre Type + +`object[]` ([User-defined installation script that runs before the installation starts](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md)) diff --git a/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts.md b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts.md new file mode 100644 index 0000000..b681b73 --- /dev/null +++ b/docs/user/unattended/reference/profile-properties-user-defined-installation-scripts.md @@ -0,0 +1,96 @@ +# User-defined installation scripts Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts +``` + +User-defined scripts to run at different points of the installation + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json\*](profile.schema.json "open original schema") | + +## scripts Type + +`object` ([User-defined installation scripts](profile-properties-user-defined-installation-scripts.md)) + +# scripts Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------------ | :------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [pre](#pre) | `array` | Optional | cannot be null | [Profile](profile-properties-user-defined-installation-scripts-properties-pre-installation-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/pre") | +| [postPartitioning](#postpartitioning) | `array` | Optional | cannot be null | [Profile](profile-properties-user-defined-installation-scripts-properties-post-partitioning-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/postPartitioning") | +| [post](#post) | `array` | Optional | cannot be null | [Profile](profile-properties-user-defined-installation-scripts-properties-post-installation-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/post") | +| [init](#init) | `array` | Optional | cannot be null | [Profile](profile-properties-user-defined-installation-scripts-properties-init-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/init") | + +## pre + +User-defined scripts to run before the installation starts + +`pre` + +* is optional + +* Type: `object[]` ([User-defined installation script that runs before the installation starts](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-user-defined-installation-scripts-properties-pre-installation-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/pre") + +### pre Type + +`object[]` ([User-defined installation script that runs before the installation starts](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts.md)) + +## postPartitioning + +User-defined scripts to run after the partitioning finishes + +`postPartitioning` + +* is optional + +* Type: `object[]` ([User-defined installation script that runs after the partitioning finishes](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-user-defined-installation-scripts-properties-post-partitioning-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/postPartitioning") + +### postPartitioning Type + +`object[]` ([User-defined installation script that runs after the partitioning finishes](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes.md)) + +## post + +User-defined scripts to run after the installation finishes + +`post` + +* is optional + +* Type: `object[]` ([User-defined installation script that runs after the installation finishes](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-user-defined-installation-scripts-properties-post-installation-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/post") + +### post Type + +`object[]` ([User-defined installation script that runs after the installation finishes](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes.md)) + +## init + +User-defined scripts to run booting the installed system + +`init` + +* is optional + +* Type: `object[]` ([User-defined installation script that runs during the first boot of the target system, once the installation is finished](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-user-defined-installation-scripts-properties-init-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts/properties/init") + +### init Type + +`object[]` ([User-defined installation script that runs during the first boot of the target system, once the installation is finished](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished.md)) diff --git a/docs/user/unattended/reference/profile.md b/docs/user/unattended/reference/profile.md new file mode 100644 index 0000000..f42d067 --- /dev/null +++ b/docs/user/unattended/reference/profile.md @@ -0,0 +1,758 @@ +# Profile Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json +``` + +Profile definition for automated installation + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [profile.schema.json](profile.schema.json "open original schema") | + +## Profile Type + +`object` ([Profile](profile.md)) + +# Profile Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [files](#files) | `array` | Optional | cannot be null | [Profile](profile-properties-user-defined-files-to-deploy.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/files") | +| [scripts](#scripts) | `object` | Optional | cannot be null | [Profile](profile-properties-user-defined-installation-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts") | +| [bootloader](#bootloader) | Merged | Optional | cannot be null | [Profile](profile-properties-bootloader-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader") | +| [hostname](#hostname) | `object` | Optional | cannot be null | [Profile](profile-properties-hostname-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname") | +| [software](#software) | `object` | Optional | cannot be null | [Profile](profile-properties-software-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software") | +| [product](#product) | `object` | Optional | cannot be null | [Profile](profile-properties-product-to-install.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product") | +| [network](#network) | `object` | Optional | cannot be null | [Profile](profile-properties-network-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network") | +| [user](#user) | `object` | Optional | cannot be null | [Profile](profile-properties-first-user-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user") | +| [root](#root) | `object` | Optional | cannot be null | [Profile](profile-properties-root-authentication-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root") | +| [localization](#localization) | `object` | Optional | cannot be null | [Profile](profile-properties-localization-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization") | +| [storage](#storage) | `object` | Optional | cannot be null | [Profile](storage-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/storage") | +| [legacyAutoyastStorage](#legacyautoyaststorage) | `array` | Optional | cannot be null | [Profile](profile-properties-legacy-autoyast-storage-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/legacyAutoyastStorage") | + +## files + +User-defined files to deploy after installation just before post install scripts + +`files` + +* is optional + +* Type: `object[]` ([User-defined file to deploy](profile-defs-user-defined-file-to-deploy.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-user-defined-files-to-deploy.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/files") + +### files Type + +`object[]` ([User-defined file to deploy](profile-defs-user-defined-file-to-deploy.md)) + +## scripts + +User-defined scripts to run at different points of the installation + +`scripts` + +* is optional + +* Type: `object` ([User-defined installation scripts](profile-properties-user-defined-installation-scripts.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-user-defined-installation-scripts.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/scripts") + +### scripts Type + +`object` ([User-defined installation scripts](profile-properties-user-defined-installation-scripts.md)) + +## bootloader + + + +`bootloader` + +* is optional + +* Type: `object` ([Bootloader settings](profile-properties-bootloader-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-bootloader-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/bootloader") + +### bootloader Type + +`object` ([Bootloader settings](profile-properties-bootloader-settings.md)) + +one (and only one) of + +* [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-0.md "check type definition") + +* [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-1.md "check type definition") + +* not + + * any of + + * [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-0.md "check type definition") + + * [Untitled undefined type in Profile](profile-properties-bootloader-settings-oneof-2-not-anyof-1.md "check type definition") + +## hostname + + + +`hostname` + +* is optional + +* Type: `object` ([Hostname settings](profile-properties-hostname-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-hostname-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/hostname") + +### hostname Type + +`object` ([Hostname settings](profile-properties-hostname-settings.md)) + +## software + + + +`software` + +* is optional + +* Type: `object` ([Software settings](profile-properties-software-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-software-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/software") + +### software Type + +`object` ([Software settings](profile-properties-software-settings.md)) + +## product + + + +`product` + +* is optional + +* Type: `object` ([Product to install](profile-properties-product-to-install.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-product-to-install.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/product") + +### product Type + +`object` ([Product to install](profile-properties-product-to-install.md)) + +## network + + + +`network` + +* is optional + +* Type: `object` ([Network settings](profile-properties-network-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-network-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/network") + +### network Type + +`object` ([Network settings](profile-properties-network-settings.md)) + +## user + + + +`user` + +* is optional + +* Type: `object` ([First user settings](profile-properties-first-user-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-first-user-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/user") + +### user Type + +`object` ([First user settings](profile-properties-first-user-settings.md)) + +## root + + + +`root` + +* is optional + +* Type: `object` ([Root authentication settings](profile-properties-root-authentication-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-root-authentication-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/root") + +### root Type + +`object` ([Root authentication settings](profile-properties-root-authentication-settings.md)) + +## localization + + + +`localization` + +* is optional + +* Type: `object` ([Localization settings](profile-properties-localization-settings.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-localization-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/localization") + +### localization Type + +`object` ([Localization settings](profile-properties-localization-settings.md)) + +## storage + +Storage config. + +> Based on doc/auto\_storage.md + +`storage` + +* is optional + +* Type: `object` ([Config](storage-1.md)) + +* cannot be null + +* defined in: [Profile](storage-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/storage") + +### storage Type + +`object` ([Config](storage-1.md)) + +## legacyAutoyastStorage + +Accepts all options of the AutoYaST partitioning section (i.e., XML to JSON) + +`legacyAutoyastStorage` + +* is optional + +* Type: `object[]` ([Details](profile-properties-legacy-autoyast-storage-settings-items.md)) + +* cannot be null + +* defined in: [Profile](profile-properties-legacy-autoyast-storage-settings.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/properties/legacyAutoyastStorage") + +### legacyAutoyastStorage Type + +`object[]` ([Details](profile-properties-legacy-autoyast-storage-settings-items.md)) + +# Profile Definitions + +## Definitions group preScript + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [name](#name) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/name") | +| [body](#body) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/body") | +| [content](#content) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/content") | +| [url](#url) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/url") | + +### name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/name") + +#### name Type + +`string` + +### body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/body") + +#### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content.md)) + +### content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/content") + +#### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-content-1.md)) + +### url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/preScript/properties/url") + +#### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-before-the-installation-starts-properties-script-url.md)) + +## Definitions group postPartitioning + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name-1) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/name") | +| [body](#body-1) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/body") | +| [content](#content-1) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/content") | +| [url](#url-1) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/url") | + +### name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/name") + +#### name Type + +`string` + +### body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/body") + +#### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content.md)) + +### content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/content") + +#### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-content-1.md)) + +### url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postPartitioning/properties/url") + +#### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-partitioning-finishes-properties-script-url.md)) + +## Definitions group postScript + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name-2) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/name") | +| [body](#body-2) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/body") | +| [content](#content-2) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/content") | +| [url](#url-2) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/url") | +| [chroot](#chroot) | `boolean` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/chroot") | + +### name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/name") + +#### name Type + +`string` + +### body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/body") + +#### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content.md)) + +### content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/content") + +#### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-content-1.md)) + +### url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/url") + +#### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-script-url.md)) + +### chroot + +whether to chroot to the target system (default: yes) or not + +`chroot` + +* is optional + +* Type: `boolean` ([Whether it should run in the installed system using a chroot environment](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/postScript/properties/chroot") + +#### chroot Type + +`boolean` ([Whether it should run in the installed system using a chroot environment](profile-defs-user-defined-installation-script-that-runs-after-the-installation-finishes-properties-whether-it-should-run-in-the-installed-system-using-a-chroot-environment.md)) + +## Definitions group initScript + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name-3) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/name") | +| [body](#body-3) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/body") | +| [content](#content-3) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/content") | +| [url](#url-3) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/url") | + +### name + +Script name, to be used as file name + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/name") + +#### name Type + +`string` + +### body + +Script content, starting with the shebang. DEPRECATED: replaced by 'content' + +`body` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/body") + +#### body Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content.md)) + +### content + +Script content, starting with the shebang. + +`content` + +* is optional + +* Type: `string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/content") + +#### content Type + +`string` ([Script content](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-content-1.md)) + +### url + +URL to fetch the script from + +`url` + +* is optional + +* Type: unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/initScript/properties/url") + +#### url Type + +unknown ([Script URL](profile-defs-user-defined-installation-script-that-runs-during-the-first-boot-of-the-target-system-once-the-installation-is-finished-properties-script-url.md)) + +## Definitions group file + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [destination](#destination) | `string` | Required | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-destination.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/destination") | +| [content](#content-4) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/content") | +| [url](#url-4) | Not specified | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/url") | +| [permissions](#permissions) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/permissions") | +| [user](#user-1) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/user") | +| [group](#group) | `string` | Optional | cannot be null | [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/group") | + +### destination + +path where file should be deployed + +`destination` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-destination.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/destination") + +#### destination Type + +`string` + +### content + +File content + +`content` + +* is optional + +* Type: `string` ([File content](profile-defs-user-defined-file-to-deploy-properties-file-content.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-content.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/content") + +#### content Type + +`string` ([File content](profile-defs-user-defined-file-to-deploy-properties-file-content.md)) + +### url + +URL to fetch the file from + +`url` + +* is optional + +* Type: unknown ([File URL](profile-defs-user-defined-file-to-deploy-properties-file-url.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-url.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/url") + +#### url Type + +unknown ([File URL](profile-defs-user-defined-file-to-deploy-properties-file-url.md)) + +### permissions + +file permissions on installed system + +`permissions` + +* is optional + +* Type: `string` ([File permissions](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/permissions") + +#### permissions Type + +`string` ([File permissions](profile-defs-user-defined-file-to-deploy-properties-file-permissions.md)) + +### user + +User owning the file on installed system. User has to already exist + +`user` + +* is optional + +* Type: `string` ([File owner user](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/user") + +#### user Type + +`string` ([File owner user](profile-defs-user-defined-file-to-deploy-properties-file-owner-user.md)) + +### group + +Group owning the file on installed system. User has to already exist + +`group` + +* is optional + +* Type: `string` ([File owner group](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md)) + +* cannot be null + +* defined in: [Profile](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json#/$defs/file/properties/group") + +#### group Type + +`string` ([File owner group](profile-defs-user-defined-file-to-deploy-properties-file-owner-group.md)) diff --git a/docs/user/unattended/reference/profile.schema.json b/docs/user/unattended/reference/profile.schema.json new file mode 100644 index 0000000..9d98b3f --- /dev/null +++ b/docs/user/unattended/reference/profile.schema.json @@ -0,0 +1 @@ +{"$id":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/profile.schema.json","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Profile","description":"Profile definition for automated installation","type":"object","additionalProperties":false,"properties":{"files":{"title":"User-defined files to deploy","description":"User-defined files to deploy after installation just before post install scripts","type":"array","items":{"$ref":"#/$defs/file"}},"scripts":{"title":"User-defined installation scripts","description":"User-defined scripts to run at different points of the installation","type":"object","additionalProperties":false,"properties":{"pre":{"title":"Pre-installation scripts","description":"User-defined scripts to run before the installation starts","type":"array","items":{"$ref":"#/$defs/preScript"}},"postPartitioning":{"title":"Post-partitioning scripts","description":"User-defined scripts to run after the partitioning finishes","type":"array","items":{"$ref":"#/$defs/postPartitioning"}},"post":{"title":"Post-installation scripts","description":"User-defined scripts to run after the installation finishes","type":"array","items":{"$ref":"#/$defs/postScript"}},"init":{"title":"Init scripts","description":"User-defined scripts to run booting the installed system","type":"array","items":{"$ref":"#/$defs/initScript"}}}},"bootloader":{"title":"Bootloader settings","type":"object","properties":{"stopOnBootMenu":{"title":"Specify if bootloader should stop on menu during boot.","type":"boolean"},"timeout":{"title":"Specify how long bootloader should wait on menu before going with default entry.","type":"integer","minimum":0}},"oneOf":[{"required":["stopOnBootMenu"]},{"required":["timeout"]},{"not":{"anyOf":[{"required":["stopOnBootMenu"]},{"required":["timeout"]}]}}]},"hostname":{"title":"Hostname settings","type":"object","properties":{"static":{"title":"System static hostname.","type":"string"},"transient":{"title":"System transient hostname.","type":"string"}}},"software":{"title":"Software settings","type":"object","properties":{"patterns":{"title":"List of patterns to install","type":"array","items":{"type":"string","examples":["minimal_base"]}},"packages":{"title":"List of packages to install","type":"array","items":{"type":"string","examples":["vim"]}}}},"product":{"title":"Product to install","type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"title":"Product identifier","description":"The id field from a products.d/foo.yaml file","icon":"Product Icon path specified in products.d/foo.yaml file","type":"string"},"registrationCode":{"title":"Product registration code","type":"string"},"registrationEmail":{"title":"Product registration email","type":"string"}}},"network":{"title":"Network settings","type":"object","additionalProperties":false,"properties":{"connections":{"title":"Network connections to be defined","type":"array","items":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"title":"Connection ID","type":"string"},"interface":{"title":"The name of the network interface bound to this connection","type":"string"},"macAddress":{"title":"Custom MAC address","description":"Can also be 'preserve', 'permanent', 'random' or 'stable'.","type":"string"},"mtu":{"description":"Connection MTU","type":"integer","minimum":0},"method4":{"title":"IPv4 configuration method","type":"string","enum":["auto","manual","link-local","disabled"]},"method6":{"title":"IPv6 configuration method","type":"string","enum":["auto","manual","link-local","disabled"]},"gateway4":{"title":"Connection gateway address","type":"string","examples":["192.168.122.1"]},"gateway6":{"title":"Connection gateway address","type":"string","examples":["::ffff:c0a8:7a01"]},"addresses":{"type":"array","items":{"title":"Connection addresses","type":"string"}},"nameservers":{"type":"array","items":{"title":"Nameservers","description":"IPv4 and/or IPv6 are allowed.","type":"string"}},"dns_searchlist":{"type":"array","items":{"description":"DNS search domains","type":"string","additionalProperties":false}},"ignoreAutoDns":{"description":"Whether DNS options provided via DHCP are used or not","type":"boolean"},"status":{"title":"Connection status","description":"The status of the connection","type":"string","enum":["up","down","removed"]},"autoconnect":{"title":"Auto-connected","description":"Whether the connection should be automatically connected","type":"boolean"},"wireless":{"type":"object","title":"Wireless configuration","additionalProperties":false,"properties":{"password":{"title":"Password of the wireless network","type":"string"},"security":{"title":"Security method/key management","type":"string","enum":["none","owe","ieee8021x","wpa-psk","sae","wpa-eap","wpa-eap-suite-b-192"]},"ssid":{"title":"SSID of the wireless network","type":"string"},"mode":{"title":"Wireless network mode","type":"string","enum":["infrastructure","adhoc","mesh","ap"]},"hidden":{"title":"Indicates that the wireless network is not broadcasting its SSID","type":"boolean"},"band":{"title":"Frequency band of the wireless network","type":"string","enum":["a","bg"]},"channel":{"title":"Wireless channel of the wireless network","type":"integer","minimum":0},"bssid":{"title":"Only allow connection to this mac address","type":"string"},"groupAlgorithms":{"type":"array","items":{"title":"A list of group/broadcast encryption algorithms","type":"string","enum":["wep40","wep104","tkip","ccmp"]}},"pairwiseAlgorithms":{"type":"array","items":{"title":"A list of pairwise encryption algorithms","type":"string","enum":["tkip","ccmp"]}},"wpaProtocolVersions":{"type":"array","items":{"title":"A list of allowed WPA protocol versions","type":"string","enum":["wpa","rsn"]}},"pmf":{"title":"Indicates whether Protected Management Frames must be enabled for the connection","type":"integer"}}},"bond":{"type":"object","title":"Bonding configuration","additionalProperties":false,"properties":{"mode":{"type":"string","enum":["balance-rr","active-backup","balance-xor","broadcast","802.3ad","balance-tlb","balance-alb"]},"options":{"type":"string"},"ports":{"type":"array","items":{"title":"A list of the interfaces or connections to be bonded","type":"string"}}}},"match":{"type":"object","title":"Match settings","description":"Identifies the network interface to apply the connection settings to","additionalProperties":false,"properties":{"kernel":{"type":"array","items":{"title":"A list of kernel command line arguments to match","type":"string"}},"interface":{"type":"array","items":{"title":"A list of interface names to match","type":"string"}},"driver":{"type":"array","items":{"title":"A list of driver names to match","type":"string"}},"path":{"type":"array","items":{"title":"A list of paths to match against the ID_PATH udev property of devices","type":"string"}}}},"ieee-8021x":{"type":"object","title":"IEEE 802.1x (EAP) settings","properties":{"eap":{"type":"array","items":{"title":"List of EAP methods used","type":"string","enum":["leap","md5","tls","peap","ttls","pwd","fast"]}},"phase2Auth":{"title":"Phase 2 inner auth method","type":"string","enum":["pap","chap","mschap","mschapv2","gtc","otp","md5","tls"]},"identity":{"title":"Identity string, often for example the user's login name","type":"string"},"password":{"title":"Password string used for EAP authentication","type":"string"},"caCert":{"title":"Path to CA certificate","type":"string"},"caCertPassword":{"title":"Password string for CA certificate if it is encrypted","type":"string"},"clientCert":{"title":"Path to client certificate","type":"string"},"clientCertPassword":{"title":"Password string for client certificate if it is encrypted","type":"string"},"privateKey":{"title":"Path to private key","type":"string"},"privateKeyPassword":{"title":"Password string for private key if it is encrypted","type":"string"},"anonymousIdentity":{"title":"Anonymous identity string for EAP authentication methods","type":"string"},"peapVersion":{"title":"Which PEAP version is used when PEAP is set as the EAP method in the 'eap' property","type":"string","enum":["0","1"]},"peapLabel":{"title":"Force the use of the new PEAP label during key derivation","type":"boolean"}}}}}}}},"user":{"title":"First user settings","type":"object","additionalProperties":false,"properties":{"fullName":{"title":"Full name","type":"string","examples":["Jane Doe"]},"userName":{"title":"User login name","type":"string","examples":["jane.doe"]},"password":{"title":"User password (plain text or hashed depending on the \"hashedPassword\" field)","type":"string","examples":["nots3cr3t"]},"hashedPassword":{"title":"Flag for hashed password (true) or plain text password (false or not defined)","type":"boolean"},"autologin":{"title":"Automatic user login","description":"Whether the user should be automatically logged in (only relevant in desktop systems)","type":"boolean"}},"required":["fullName","userName","password"]},"root":{"title":"Root authentication settings","type":"object","additionalProperties":false,"properties":{"password":{"title":"Root password (plain text or hashed depending on the \"hashedPassword\" field)","type":"string"},"hashedPassword":{"title":"Flag for hashed password (true) or plain text password (false or not defined)","type":"boolean"},"sshPublicKey":{"title":"SSH public key","type":"string"}}},"localization":{"title":"Localization settings","type":"object","properties":{"language":{"title":"System language ID","type":"string","examples":["en_US.UTF-8","en_US"]},"keyboard":{"title":"Keyboard layout ID","type":"string"},"timezone":{"title":"Time zone identifier such as 'Europe/Berlin'","type":"string","examples":["Europe/Berlin"]}}},"storage":{"$ref":"storage.schema.json"},"legacyAutoyastStorage":{"title":"Legacy AutoYaST storage settings","description":"Accepts all options of the AutoYaST partitioning section (i.e., XML to JSON)","type":"array","items":{"type":"object"}}},"$defs":{"preScript":{"title":"User-defined installation script that runs before the installation starts","type":"object","additionalProperties":false,"properties":{"name":{"description":"Script name, to be used as file name","type":"string"},"body":{"title":"Script content","description":"Script content, starting with the shebang. DEPRECATED: replaced by 'content'","type":"string","deprecated":true},"content":{"title":"Script content","description":"Script content, starting with the shebang.","type":"string"},"url":{"title":"Script URL","description":"URL to fetch the script from"}},"required":["name"],"oneOf":[{"required":["body"]},{"required":["url"]},{"required":["content"]}]},"postPartitioning":{"title":"User-defined installation script that runs after the partitioning finishes","type":"object","additionalProperties":false,"properties":{"name":{"description":"Script name, to be used as file name","type":"string"},"body":{"title":"Script content","description":"Script content, starting with the shebang. DEPRECATED: replaced by 'content'","type":"string","deprecated":true},"content":{"title":"Script content","description":"Script content, starting with the shebang.","type":"string"},"url":{"title":"Script URL","description":"URL to fetch the script from"}},"required":["name"],"oneOf":[{"required":["body"]},{"required":["url"]},{"required":["content"]}]},"postScript":{"title":"User-defined installation script that runs after the installation finishes","type":"object","additionalProperties":false,"properties":{"name":{"description":"Script name, to be used as file name","type":"string"},"body":{"title":"Script content","description":"Script content, starting with the shebang. DEPRECATED: replaced by 'content'","type":"string","deprecated":true},"content":{"title":"Script content","description":"Script content, starting with the shebang.","type":"string"},"url":{"title":"Script URL","description":"URL to fetch the script from"},"chroot":{"title":"Whether it should run in the installed system using a chroot environment","description":"whether to chroot to the target system (default: yes) or not","type":"boolean"}},"required":["name"],"oneOf":[{"required":["body"]},{"required":["url"]},{"required":["content"]}]},"initScript":{"title":"User-defined installation script that runs during the first boot of the target system, once the installation is finished","type":"object","additionalProperties":false,"properties":{"name":{"description":"Script name, to be used as file name","type":"string"},"body":{"title":"Script content","description":"Script content, starting with the shebang. DEPRECATED: replaced by 'content'","type":"string","deprecated":true},"content":{"title":"Script content","description":"Script content, starting with the shebang.","type":"string"},"url":{"title":"Script URL","description":"URL to fetch the script from"}},"required":["name"],"oneOf":[{"required":["body"]},{"required":["url"]},{"required":["content"]}]},"file":{"title":"User-defined file to deploy","type":"object","additionalProperties":false,"properties":{"destination":{"description":"path where file should be deployed","type":"string"},"content":{"title":"File content","description":"File content","type":"string"},"url":{"title":"File URL","description":"URL to fetch the file from"},"permissions":{"title":"File permissions","description":"file permissions on installed system","type":"string"},"user":{"title":"File owner user","description":"User owning the file on installed system. User has to already exist","type":"string"},"group":{"title":"File owner group","description":"Group owning the file on installed system. User has to already exist","type":"string"}},"required":["destination"],"oneOf":[{"required":["url"]},{"required":["content"]}]}}} diff --git a/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-logicalvolumes.md b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-logicalvolumes.md new file mode 100644 index 0000000..7cc9958 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-logicalvolumes.md @@ -0,0 +1,24 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/logicalVolumes +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## logicalVolumes Type + +unknown + +## logicalVolumes Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"default"` | | +| `"mandatory"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-stripes.md b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-stripes.md new file mode 100644 index 0000000..6672c94 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-stripes.md @@ -0,0 +1,21 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/stripes +``` + +Number of stripes. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## stripes Type + +`integer` + +## stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` diff --git a/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md new file mode 100644 index 0000000..b0e2623 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md @@ -0,0 +1,129 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## generate Type + +`object` ([Details](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md)) + +# generate Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [logicalVolumes](#logicalvolumes) | Not specified | Required | cannot be null | [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/logicalVolumes") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/encryption") | +| [stripes](#stripes) | `integer` | Optional | cannot be null | [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/stripes") | +| [stripeSize](#stripesize) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/stripeSize") | + +## logicalVolumes + + + +`logicalVolumes` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/logicalVolumes") + +### logicalVolumes Type + +unknown + +### logicalVolumes Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"default"` | | +| `"mandatory"` | | + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") + +## stripes + +Number of stripes. + +`stripes` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/stripes") + +### stripes Type + +`integer` + +### stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` + +## stripeSize + + + +`stripeSize` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevalue.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate/properties/stripeSize") + +### stripeSize Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator.md b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator.md new file mode 100644 index 0000000..c20dd9a --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedlogicalvolumesgenerator.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator +``` + +Automatically creates the default or mandatory logical volumes configured by the selected product. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## advancedLogicalVolumesGenerator Type + +`object` ([Details](storage-1-defs-advancedlogicalvolumesgenerator.md)) + +# advancedLogicalVolumesGenerator Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate) | `object` | Required | cannot be null | [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate") | + +## generate + + + +`generate` + +* is required + +* Type: `object` ([Details](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate") + +### generate Type + +`object` ([Details](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator-properties-generate-properties-partitions.md b/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator-properties-generate-properties-partitions.md new file mode 100644 index 0000000..1b902f1 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator-properties-generate-properties-partitions.md @@ -0,0 +1,24 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate/properties/partitions +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## partitions Type + +unknown + +## partitions Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"default"` | | +| `"mandatory"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator-properties-generate.md b/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator-properties-generate.md new file mode 100644 index 0000000..c26b6db --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator-properties-generate.md @@ -0,0 +1,79 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## generate Type + +`object` ([Details](storage-1-defs-advancedpartitionsgenerator-properties-generate.md)) + +# generate Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [partitions](#partitions) | Not specified | Required | cannot be null | [Config](storage-1-defs-advancedpartitionsgenerator-properties-generate-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate/properties/partitions") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate/properties/encryption") | + +## partitions + + + +`partitions` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedpartitionsgenerator-properties-generate-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate/properties/partitions") + +### partitions Type + +unknown + +### partitions Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"default"` | | +| `"mandatory"` | | + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator.md b/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator.md new file mode 100644 index 0000000..c7861f7 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedpartitionsgenerator.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator +``` + +Creates the default or mandatory partitions configured by the selected product. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## advancedPartitionsGenerator Type + +`object` ([Details](storage-1-defs-advancedpartitionsgenerator.md)) + +# advancedPartitionsGenerator Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate) | `object` | Required | cannot be null | [Config](storage-1-defs-advancedpartitionsgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate") | + +## generate + + + +`generate` + +* is required + +* Type: `object` ([Details](storage-1-defs-advancedpartitionsgenerator-properties-generate.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedpartitionsgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate") + +### generate Type + +`object` ([Details](storage-1-defs-advancedpartitionsgenerator-properties-generate.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices-items.md b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices-items.md new file mode 100644 index 0000000..46d086b --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices-items.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate/properties/targetDevices/items +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices.md b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices.md new file mode 100644 index 0000000..e1176a3 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate/properties/targetDevices +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## targetDevices Type + +`string[]` diff --git a/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md new file mode 100644 index 0000000..0f577a2 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md @@ -0,0 +1,70 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## generate Type + +`object` ([Details](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md)) + +# generate Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------------ | :------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [targetDevices](#targetdevices) | `array` | Required | cannot be null | [Config](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate/properties/targetDevices") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate/properties/encryption") | + +## targetDevices + + + +`targetDevices` + +* is required + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate-properties-targetdevices.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate/properties/targetDevices") + +### targetDevices Type + +`string[]` + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator.md b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator.md new file mode 100644 index 0000000..2b615a5 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedphysicalvolumesgenerator.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator +``` + +Automatically creates the needed physical volumes in the indicated devices. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## advancedPhysicalVolumesGenerator Type + +`object` ([Details](storage-1-defs-advancedphysicalvolumesgenerator.md)) + +# advancedPhysicalVolumesGenerator Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [generate](#generate) | `object` | Required | cannot be null | [Config](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate") | + +## generate + + + +`generate` + +* is required + +* Type: `object` ([Details](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate") + +### generate Type + +`object` ([Details](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-max.md b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-max.md new file mode 100644 index 0000000..19d489f --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-max.md @@ -0,0 +1,19 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/max +``` + +Maximum devices to match. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## max Type + +`integer` + +## max Constraints + +**minimum**: the value of this number must greater than or equal to: `1` diff --git a/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-action.md b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-action.md new file mode 100644 index 0000000..6b50b1e --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-action.md @@ -0,0 +1,32 @@ +# Search action Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/ifNotFound +``` + +How to handle the section if the device is not found. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## ifNotFound Type + +unknown ([Search action](storage-1-defs-advancedsearch-properties-search-action.md)) + +## ifNotFound Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"skip"` | | +| `"error"` | | + +## ifNotFound Default Value + +The default value is: + +```json +"error" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-condition-properties-name.md b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-condition-properties-name.md new file mode 100644 index 0000000..b744483 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-condition-properties-name.md @@ -0,0 +1,25 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition/properties/name +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## name Type + +`string` + +## name Examples + +```json +"/dev/vda" +``` + +```json +"/dev/disk/by-id/ata-WDC_WD3200AAKS-75L9" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-condition.md b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-condition.md new file mode 100644 index 0000000..aa20814 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedsearch-properties-search-condition.md @@ -0,0 +1,49 @@ +# Search condition Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## condition Type + +`object` ([Search condition](storage-1-defs-advancedsearch-properties-search-condition.md)) + +# condition Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------ | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Required | cannot be null | [Config](storage-1-defs-advancedsearch-properties-search-condition-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition/properties/name") | + +## name + + + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedsearch-properties-search-condition-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition/properties/name") + +### name Type + +`string` + +### name Examples + +```json +"/dev/vda" +``` + +```json +"/dev/disk/by-id/ata-WDC_WD3200AAKS-75L9" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-advancedsearch.md b/docs/user/unattended/reference/storage-1-defs-advancedsearch.md new file mode 100644 index 0000000..4f12b50 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-advancedsearch.md @@ -0,0 +1,98 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch +``` + +Advanced options for searching devices. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## advancedSearch Type + +`object` ([Details](storage-1-defs-advancedsearch.md)) + +# advancedSearch Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [condition](#condition) | `object` | Optional | cannot be null | [Config](storage-1-defs-advancedsearch-properties-search-condition.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition") | +| [max](#max) | `integer` | Optional | cannot be null | [Config](storage-1-defs-advancedsearch-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/max") | +| [ifNotFound](#ifnotfound) | Not specified | Optional | cannot be null | [Config](storage-1-defs-advancedsearch-properties-search-action.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/ifNotFound") | + +## condition + + + +`condition` + +* is optional + +* Type: `object` ([Search condition](storage-1-defs-advancedsearch-properties-search-condition.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedsearch-properties-search-condition.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition") + +### condition Type + +`object` ([Search condition](storage-1-defs-advancedsearch-properties-search-condition.md)) + +## max + +Maximum devices to match. + +`max` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedsearch-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/max") + +### max Type + +`integer` + +### max Constraints + +**minimum**: the value of this number must greater than or equal to: `1` + +## ifNotFound + +How to handle the section if the device is not found. + +`ifNotFound` + +* is optional + +* Type: unknown ([Search action](storage-1-defs-advancedsearch-properties-search-action.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedsearch-properties-search-action.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/ifNotFound") + +### ifNotFound Type + +unknown ([Search action](storage-1-defs-advancedsearch-properties-search-action.md)) + +### ifNotFound Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"skip"` | | +| `"error"` | | + +### ifNotFound Default Value + +The default value is: + +```json +"error" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-alias.md b/docs/user/unattended/reference/storage-1-defs-alias.md new file mode 100644 index 0000000..26120e5 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-alias.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/alias +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## alias Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-boot-properties-configure.md b/docs/user/unattended/reference/storage-1-defs-boot-properties-configure.md new file mode 100644 index 0000000..2ba7c4b --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-boot-properties-configure.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/configure +``` + +Whether to configure partitions for booting. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## configure Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-1-defs-boot-properties-device.md b/docs/user/unattended/reference/storage-1-defs-boot-properties-device.md new file mode 100644 index 0000000..4f7bba0 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-boot-properties-device.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/device +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## device Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-boot.md b/docs/user/unattended/reference/storage-1-defs-boot.md new file mode 100644 index 0000000..526c327 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-boot.md @@ -0,0 +1,58 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot +``` + +Allows configuring boot partitions automatically. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## boot Type + +`object` ([Details](storage-1-defs-boot.md)) + +# boot Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [configure](#configure) | `boolean` | Required | cannot be null | [Config](storage-1-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/configure") | +| [device](#device) | `string` | Optional | cannot be null | [Config](storage-1-defs-boot-properties-device.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/device") | + +## configure + +Whether to configure partitions for booting. + +`configure` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-1-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/configure") + +### configure Type + +`boolean` + +## device + +Alias used to reference a device. + +`device` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-boot-properties-device.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/device") + +### device Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-driveelement.md b/docs/user/unattended/reference/storage-1-defs-driveelement.md new file mode 100644 index 0000000..93ae5a3 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-driveelement.md @@ -0,0 +1,21 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/driveElement +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## driveElement Type + +merged type ([Details](storage-1-defs-driveelement.md)) + +any of + +* [Untitled object in Config](storage-1-defs-formatteddrive.md "check type definition") + +* [Untitled object in Config](storage-1-defs-partitioneddrive.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-encryption-anyof-4.md b/docs/user/unattended/reference/storage-1-defs-encryption-anyof-4.md new file mode 100644 index 0000000..a0f245a --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryption-anyof-4.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryption/anyOf/4 +``` + +Swap encryptions. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 4 Type + +unknown + +## 4 Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------------- | :---------- | +| `"protected_swap"` | | +| `"secure_swap"` | | +| `"random_swap"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-encryption.md b/docs/user/unattended/reference/storage-1-defs-encryption.md new file mode 100644 index 0000000..83519a6 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryption.md @@ -0,0 +1,27 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryption +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-encryptioncipher.md b/docs/user/unattended/reference/storage-1-defs-encryptioncipher.md new file mode 100644 index 0000000..1dfe0fc --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptioncipher.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionCipher +``` + +The value must be compatible with the --cipher argument of the command cryptsetup. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionCipher Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionkeysize.md b/docs/user/unattended/reference/storage-1-defs-encryptionkeysize.md new file mode 100644 index 0000000..0c1d9ac --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionkeysize.md @@ -0,0 +1,15 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionKeySize +``` + +The value (in bits) has to be a multiple of 8. The possible key sizes are limited by the used cipher. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionKeySize Type + +`integer` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-cipher.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-cipher.md new file mode 100644 index 0000000..ccfc0ad --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-cipher.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/cipher +``` + +The value must be compatible with the --cipher argument of the command cryptsetup. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## cipher Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-keysize.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-keysize.md new file mode 100644 index 0000000..50cf3a4 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-keysize.md @@ -0,0 +1,15 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/keySize +``` + +The value (in bits) has to be a multiple of 8. The possible key sizes are limited by the used cipher. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## keySize Type + +`integer` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-password.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-password.md new file mode 100644 index 0000000..f4e8fc8 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1-properties-password.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/password +``` + +Password to use when creating a new encryption device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## password Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1.md new file mode 100644 index 0000000..b089d90 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks1-properties-luks1.md @@ -0,0 +1,77 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## luks1 Type + +`object` ([Details](storage-1-defs-encryptionluks1-properties-luks1.md)) + +# luks1 Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [password](#password) | `string` | Required | cannot be null | [Config](storage-1-defs-encryptionluks1-properties-luks1-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/password") | +| [cipher](#cipher) | `string` | Optional | cannot be null | [Config](storage-1-defs-encryptionluks1-properties-luks1-properties-cipher.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/cipher") | +| [keySize](#keysize) | `integer` | Optional | cannot be null | [Config](storage-1-defs-encryptionluks1-properties-luks1-properties-keysize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/keySize") | + +## password + +Password to use when creating a new encryption device. + +`password` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks1-properties-luks1-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/password") + +### password Type + +`string` + +## cipher + +The value must be compatible with the --cipher argument of the command cryptsetup. + +`cipher` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks1-properties-luks1-properties-cipher.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/cipher") + +### cipher Type + +`string` + +## keySize + +The value (in bits) has to be a multiple of 8. The possible key sizes are limited by the used cipher. + +`keySize` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks1-properties-luks1-properties-keysize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1/properties/keySize") + +### keySize Type + +`integer` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks1.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks1.md new file mode 100644 index 0000000..07c907a --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks1.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1 +``` + +LUKS1 encryption. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionLuks1 Type + +`object` ([Details](storage-1-defs-encryptionluks1.md)) + +# encryptionLuks1 Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [luks1](#luks1) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptionluks1-properties-luks1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1") | + +## luks1 + + + +`luks1` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptionluks1-properties-luks1.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks1-properties-luks1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1") + +### luks1 Type + +`object` ([Details](storage-1-defs-encryptionluks1-properties-luks1.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-cipher.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-cipher.md new file mode 100644 index 0000000..0b6cd9f --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-cipher.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/cipher +``` + +The value must be compatible with the --cipher argument of the command cryptsetup. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## cipher Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-keysize.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-keysize.md new file mode 100644 index 0000000..5a0316f --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-keysize.md @@ -0,0 +1,15 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/keySize +``` + +The value (in bits) has to be a multiple of 8. The possible key sizes are limited by the used cipher. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## keySize Type + +`integer` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-label.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-label.md new file mode 100644 index 0000000..11b13b2 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-label.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/label +``` + +LUKS2 label. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## label Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-password.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-password.md new file mode 100644 index 0000000..ca5f22a --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-password.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/password +``` + +Password to use when creating a new encryption device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## password Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-pbkdfunction.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-pbkdfunction.md new file mode 100644 index 0000000..8e41762 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2-properties-pbkdfunction.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/pbkdFunction +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## pbkdFunction Type + +unknown + +## pbkdFunction Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"pbkdf2"` | | +| `"argon2i"` | | +| `"argon2id"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2.md new file mode 100644 index 0000000..4056c05 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks2-properties-luks2.md @@ -0,0 +1,125 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## luks2 Type + +`object` ([Details](storage-1-defs-encryptionluks2-properties-luks2.md)) + +# luks2 Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [password](#password) | `string` | Required | cannot be null | [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/password") | +| [cipher](#cipher) | `string` | Optional | cannot be null | [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-cipher.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/cipher") | +| [keySize](#keysize) | `integer` | Optional | cannot be null | [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-keysize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/keySize") | +| [pbkdFunction](#pbkdfunction) | Not specified | Optional | cannot be null | [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-pbkdfunction.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/pbkdFunction") | +| [label](#label) | `string` | Optional | cannot be null | [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/label") | + +## password + +Password to use when creating a new encryption device. + +`password` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/password") + +### password Type + +`string` + +## cipher + +The value must be compatible with the --cipher argument of the command cryptsetup. + +`cipher` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-cipher.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/cipher") + +### cipher Type + +`string` + +## keySize + +The value (in bits) has to be a multiple of 8. The possible key sizes are limited by the used cipher. + +`keySize` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-keysize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/keySize") + +### keySize Type + +`integer` + +## pbkdFunction + + + +`pbkdFunction` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-pbkdfunction.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/pbkdFunction") + +### pbkdFunction Type + +unknown + +### pbkdFunction Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"pbkdf2"` | | +| `"argon2i"` | | +| `"argon2id"` | | + +## label + +LUKS2 label. + +`label` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks2-properties-luks2-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2/properties/label") + +### label Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionluks2.md b/docs/user/unattended/reference/storage-1-defs-encryptionluks2.md new file mode 100644 index 0000000..9968cc4 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionluks2.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2 +``` + +LUKS2 encryption. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionLuks2 Type + +`object` ([Details](storage-1-defs-encryptionluks2.md)) + +# encryptionLuks2 Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [luks2](#luks2) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptionluks2-properties-luks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2") | + +## luks2 + + + +`luks2` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptionluks2-properties-luks2.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks2-properties-luks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2") + +### luks2 Type + +`object` ([Details](storage-1-defs-encryptionluks2-properties-luks2.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionpassword.md b/docs/user/unattended/reference/storage-1-defs-encryptionpassword.md new file mode 100644 index 0000000..07cfae0 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionpassword.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPassword +``` + +Password to use when creating a new encryption device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionPassword Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionpbkdfunction.md b/docs/user/unattended/reference/storage-1-defs-encryptionpbkdfunction.md new file mode 100644 index 0000000..d541d87 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionpbkdfunction.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPbkdFunction +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionPbkdFunction Type + +unknown + +## encryptionPbkdFunction Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"pbkdf2"` | | +| `"argon2i"` | | +| `"argon2id"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2-properties-password.md b/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2-properties-password.md new file mode 100644 index 0000000..863d578 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2-properties-password.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2/properties/password +``` + +Password to use when creating a new encryption device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## password Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md b/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md new file mode 100644 index 0000000..6284d5d --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## pervasiveLuks2 Type + +`object` ([Details](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md)) + +# pervasiveLuks2 Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [password](#password) | `string` | Required | cannot be null | [Config](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2/properties/password") | + +## password + +Password to use when creating a new encryption device. + +`password` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2/properties/password") + +### password Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2.md b/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2.md new file mode 100644 index 0000000..f58b649 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionpervasiveluks2.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2 +``` + +LUKS2 pervasive encryption. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionPervasiveLuks2 Type + +`object` ([Details](storage-1-defs-encryptionpervasiveluks2.md)) + +# encryptionPervasiveLuks2 Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [pervasiveLuks2](#pervasiveluks2) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2") | + +## pervasiveLuks2 + + + +`pervasiveLuks2` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2") + +### pervasiveLuks2 Type + +`object` ([Details](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-encryptionswap.md b/docs/user/unattended/reference/storage-1-defs-encryptionswap.md new file mode 100644 index 0000000..87df881 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptionswap.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionSwap +``` + +Swap encryptions. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionSwap Type + +unknown + +## encryptionSwap Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------------- | :---------- | +| `"protected_swap"` | | +| `"secure_swap"` | | +| `"random_swap"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-encryptiontpm-properties-tpmfde-properties-password.md b/docs/user/unattended/reference/storage-1-defs-encryptiontpm-properties-tpmfde-properties-password.md new file mode 100644 index 0000000..ea1d0ae --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptiontpm-properties-tpmfde-properties-password.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde/properties/password +``` + +Password to use when creating a new encryption device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## password Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptiontpm-properties-tpmfde.md b/docs/user/unattended/reference/storage-1-defs-encryptiontpm-properties-tpmfde.md new file mode 100644 index 0000000..cacaca1 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptiontpm-properties-tpmfde.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## tpmFde Type + +`object` ([Details](storage-1-defs-encryptiontpm-properties-tpmfde.md)) + +# tpmFde Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [password](#password) | `string` | Required | cannot be null | [Config](storage-1-defs-encryptiontpm-properties-tpmfde-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde/properties/password") | + +## password + +Password to use when creating a new encryption device. + +`password` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptiontpm-properties-tpmfde-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde/properties/password") + +### password Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-encryptiontpm.md b/docs/user/unattended/reference/storage-1-defs-encryptiontpm.md new file mode 100644 index 0000000..6533964 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-encryptiontpm.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM +``` + +TPM-Based Full Disk Encrytion. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## encryptionTPM Type + +`object` ([Details](storage-1-defs-encryptiontpm.md)) + +# encryptionTPM Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [tpmFde](#tpmfde) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptiontpm-properties-tpmfde.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde") | + +## tpmFde + + + +`tpmFde` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptiontpm-properties-tpmfde.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptiontpm-properties-tpmfde.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde") + +### tpmFde Type + +`object` ([Details](storage-1-defs-encryptiontpm-properties-tpmfde.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-label.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-label.md new file mode 100644 index 0000000..c63ab15 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-label.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/label +``` + +File system label. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## label Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mkfsoptions-items.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mkfsoptions-items.md new file mode 100644 index 0000000..0e66ffe --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mkfsoptions-items.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mkfsOptions/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mkfsoptions.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mkfsoptions.md new file mode 100644 index 0000000..a0c18be --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mkfsoptions.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mkfsOptions +``` + +Options for creating the file system. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## mkfsOptions Type + +`string[]` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mount-by.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mount-by.md new file mode 100644 index 0000000..f75d042 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mount-by.md @@ -0,0 +1,27 @@ +# Mount by Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountBy +``` + +How to mount the device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## mountBy Type + +unknown ([Mount by](storage-1-defs-filesystem-properties-mount-by.md)) + +## mountBy Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"device"` | | +| `"id"` | | +| `"label"` | | +| `"path"` | | +| `"uuid"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mountoptions-items.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mountoptions-items.md new file mode 100644 index 0000000..23a14c1 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mountoptions-items.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountOptions/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mountoptions.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mountoptions.md new file mode 100644 index 0000000..a85d172 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-mountoptions.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountOptions +``` + +Options to add to the fourth field of fstab. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## mountOptions Type + +`string[]` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-path.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-path.md new file mode 100644 index 0000000..b3006ae --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-path.md @@ -0,0 +1,21 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/path +``` + +Mount path. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## path Type + +`string` + +## path Examples + +```json +"/var/log" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem-properties-reuseifpossible.md b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-reuseifpossible.md new file mode 100644 index 0000000..1ae7814 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem-properties-reuseifpossible.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/reuseIfPossible +``` + +Try to reuse the existing file system. In some cases the file system could not be reused, for example, if the device is re-encrypted. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## reuseIfPossible Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystem.md b/docs/user/unattended/reference/storage-1-defs-filesystem.md new file mode 100644 index 0000000..0cf8307 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystem.md @@ -0,0 +1,177 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) + +# filesystem Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [reuseIfPossible](#reuseifpossible) | `boolean` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-reuseifpossible.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/reuseIfPossible") | +| [type](#type) | Merged | Optional | cannot be null | [Config](storage-1-defs-filesystemtype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/type") | +| [label](#label) | `string` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/label") | +| [path](#path) | `string` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-path.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/path") | +| [mountBy](#mountby) | Not specified | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-mount-by.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountBy") | +| [mkfsOptions](#mkfsoptions) | `array` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-mkfsoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mkfsOptions") | +| [mountOptions](#mountoptions) | `array` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-mountoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountOptions") | + +## reuseIfPossible + +Try to reuse the existing file system. In some cases the file system could not be reused, for example, if the device is re-encrypted. + +`reuseIfPossible` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-reuseifpossible.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/reuseIfPossible") + +### reuseIfPossible Type + +`boolean` + +## type + + + +`type` + +* is optional + +* Type: merged type ([Details](storage-1-defs-filesystemtype.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystemtype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/type") + +### type Type + +merged type ([Details](storage-1-defs-filesystemtype.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-filesystemtype-anyof-0.md "check type definition") + +* [Untitled object in Config](storage-1-defs-filesystemtypebtrfs.md "check type definition") + +## label + +File system label. + +`label` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/label") + +### label Type + +`string` + +## path + +Mount path. + +`path` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-path.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/path") + +### path Type + +`string` + +### path Examples + +```json +"/var/log" +``` + +## mountBy + +How to mount the device. + +`mountBy` + +* is optional + +* Type: unknown ([Mount by](storage-1-defs-filesystem-properties-mount-by.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-mount-by.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountBy") + +### mountBy Type + +unknown ([Mount by](storage-1-defs-filesystem-properties-mount-by.md)) + +### mountBy Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"device"` | | +| `"id"` | | +| `"label"` | | +| `"path"` | | +| `"uuid"` | | + +## mkfsOptions + +Options for creating the file system. + +`mkfsOptions` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-mkfsoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mkfsOptions") + +### mkfsOptions Type + +`string[]` + +## mountOptions + +Options to add to the fourth field of fstab. + +`mountOptions` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-mountoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountOptions") + +### mountOptions Type + +`string[]` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystemtype-anyof-0.md b/docs/user/unattended/reference/storage-1-defs-filesystemtype-anyof-0.md new file mode 100644 index 0000000..c80f64c --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystemtype-anyof-0.md @@ -0,0 +1,38 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemType/anyOf/0 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 0 Type + +unknown + +## 0 Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"bcachefs"` | | +| `"btrfs"` | | +| `"exfat"` | | +| `"ext2"` | | +| `"ext3"` | | +| `"ext4"` | | +| `"f2fs"` | | +| `"jfs"` | | +| `"nfs"` | | +| `"nilfs2"` | | +| `"ntfs"` | | +| `"reiserfs"` | | +| `"swap"` | | +| `"tmpfs"` | | +| `"vfat"` | | +| `"xfs"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-filesystemtype.md b/docs/user/unattended/reference/storage-1-defs-filesystemtype.md new file mode 100644 index 0000000..7fd131d --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystemtype.md @@ -0,0 +1,21 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemType +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## filesystemType Type + +merged type ([Details](storage-1-defs-filesystemtype.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-filesystemtype-anyof-0.md "check type definition") + +* [Untitled object in Config](storage-1-defs-filesystemtypebtrfs.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-filesystemtypeany.md b/docs/user/unattended/reference/storage-1-defs-filesystemtypeany.md new file mode 100644 index 0000000..8312398 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystemtypeany.md @@ -0,0 +1,38 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeAny +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## filesystemTypeAny Type + +unknown + +## filesystemTypeAny Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"bcachefs"` | | +| `"btrfs"` | | +| `"exfat"` | | +| `"ext2"` | | +| `"ext3"` | | +| `"ext4"` | | +| `"f2fs"` | | +| `"jfs"` | | +| `"nfs"` | | +| `"nilfs2"` | | +| `"ntfs"` | | +| `"reiserfs"` | | +| `"swap"` | | +| `"tmpfs"` | | +| `"vfat"` | | +| `"xfs"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs-properties-btrfs-properties-snapshots.md b/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs-properties-btrfs-properties-snapshots.md new file mode 100644 index 0000000..6dc9ebb --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs-properties-btrfs-properties-snapshots.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs/properties/snapshots +``` + +Whether to configrue Btrfs snapshots. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## snapshots Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs-properties-btrfs.md b/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs-properties-btrfs.md new file mode 100644 index 0000000..f770a0c --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs-properties-btrfs.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## btrfs Type + +`object` ([Details](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md)) + +# btrfs Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [snapshots](#snapshots) | `boolean` | Optional | cannot be null | [Config](storage-1-defs-filesystemtypebtrfs-properties-btrfs-properties-snapshots.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs/properties/snapshots") | + +## snapshots + +Whether to configrue Btrfs snapshots. + +`snapshots` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystemtypebtrfs-properties-btrfs-properties-snapshots.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs/properties/snapshots") + +### snapshots Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs.md b/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs.md new file mode 100644 index 0000000..3ad9228 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-filesystemtypebtrfs.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs +``` + +Btrfs file system. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## filesystemTypeBtrfs Type + +`object` ([Details](storage-1-defs-filesystemtypebtrfs.md)) + +# filesystemTypeBtrfs Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [btrfs](#btrfs) | `object` | Required | cannot be null | [Config](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs") | + +## btrfs + + + +`btrfs` + +* is required + +* Type: `object` ([Details](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs") + +### btrfs Type + +`object` ([Details](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-formatteddrive-properties-alias.md b/docs/user/unattended/reference/storage-1-defs-formatteddrive-properties-alias.md new file mode 100644 index 0000000..7f64171 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-formatteddrive-properties-alias.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/alias +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## alias Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-formatteddrive.md b/docs/user/unattended/reference/storage-1-defs-formatteddrive.md new file mode 100644 index 0000000..c3b053e --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-formatteddrive.md @@ -0,0 +1,116 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive +``` + +Drive without a partition table (e.g., directly formatted). + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## formattedDrive Type + +`object` ([Details](storage-1-defs-formatteddrive.md)) + +# formattedDrive Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [search](#search) | Merged | Optional | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/search") | +| [alias](#alias) | `string` | Optional | cannot be null | [Config](storage-1-defs-formatteddrive-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/alias") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/encryption") | +| [filesystem](#filesystem) | `object` | Required | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/filesystem") | + +## search + + + +`search` + +* is optional + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/search") + +### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-searchelement-anyof-0.md "check type definition") + +* [Untitled string in Config](storage-1-defs-searchelement-anyof-1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +## alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-formatteddrive-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/alias") + +### alias Type + +`string` + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") + +## filesystem + + + +`filesystem` + +* is required + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/filesystem") + +### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-logicalvolume-properties-name.md b/docs/user/unattended/reference/storage-1-defs-logicalvolume-properties-name.md new file mode 100644 index 0000000..a089620 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-logicalvolume-properties-name.md @@ -0,0 +1,21 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/name +``` + +Logical volume name. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## name Type + +`string` + +## name Examples + +```json +"lv0" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-logicalvolume-properties-stripes.md b/docs/user/unattended/reference/storage-1-defs-logicalvolume-properties-stripes.md new file mode 100644 index 0000000..2486a76 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-logicalvolume-properties-stripes.md @@ -0,0 +1,21 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripes +``` + +Number of stripes. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## stripes Type + +`integer` + +## stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` diff --git a/docs/user/unattended/reference/storage-1-defs-logicalvolume.md b/docs/user/unattended/reference/storage-1-defs-logicalvolume.md new file mode 100644 index 0000000..879093b --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-logicalvolume.md @@ -0,0 +1,176 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## logicalVolume Type + +`object` ([Details](storage-1-defs-logicalvolume.md)) + +# logicalVolume Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Optional | cannot be null | [Config](storage-1-defs-logicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/name") | +| [size](#size) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/size") | +| [stripes](#stripes) | `integer` | Optional | cannot be null | [Config](storage-1-defs-logicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripes") | +| [stripeSize](#stripesize) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripeSize") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/encryption") | +| [filesystem](#filesystem) | `object` | Optional | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/filesystem") | + +## name + +Logical volume name. + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-logicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/name") + +### name Type + +`string` + +### name Examples + +```json +"lv0" +``` + +## size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/size") + +### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +## stripes + +Number of stripes. + +`stripes` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-logicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripes") + +### stripes Type + +`integer` + +### stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` + +## stripeSize + + + +`stripeSize` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevalue.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripeSize") + +### stripeSize Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") + +## filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/filesystem") + +### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-logicalvolumeelement.md b/docs/user/unattended/reference/storage-1-defs-logicalvolumeelement.md new file mode 100644 index 0000000..975e1bb --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-logicalvolumeelement.md @@ -0,0 +1,27 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolumeElement +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## logicalVolumeElement Type + +merged type ([Details](storage-1-defs-logicalvolumeelement.md)) + +any of + +* [Untitled object in Config](storage-1-defs-simplevolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedlogicalvolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-logicalvolume.md "check type definition") + +* [Untitled object in Config](storage-1-defs-thinpoollogicalvolume.md "check type definition") + +* [Untitled object in Config](storage-1-defs-thinlogicalvolume.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-logicalvolumestripes.md b/docs/user/unattended/reference/storage-1-defs-logicalvolumestripes.md new file mode 100644 index 0000000..00d2f92 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-logicalvolumestripes.md @@ -0,0 +1,21 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolumeStripes +``` + +Number of stripes. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## logicalVolumeStripes Type + +`integer` + +## logicalVolumeStripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` diff --git a/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-alias.md b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-alias.md new file mode 100644 index 0000000..a723e91 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-alias.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/alias +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## alias Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-partitions-items.md b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-partitions-items.md new file mode 100644 index 0000000..ce2c7fc --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-partitions-items.md @@ -0,0 +1,27 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/partitions/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +merged type ([Details](storage-1-defs-partitioneddrive-properties-partitions-items.md)) + +any of + +* [Untitled object in Config](storage-1-defs-simplevolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedpartitionsgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-regularpartition.md "check type definition") + +* [Untitled object in Config](storage-1-defs-partitiontodelete.md "check type definition") + +* [Untitled object in Config](storage-1-defs-partitiontodeleteifneeded.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-partitions.md b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-partitions.md new file mode 100644 index 0000000..e9630b0 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-partitions.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/partitions +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## partitions Type + +an array of merged types ([Details](storage-1-defs-partitioneddrive-properties-partitions-items.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-ptabletype.md b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-ptabletype.md new file mode 100644 index 0000000..968363c --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitioneddrive-properties-ptabletype.md @@ -0,0 +1,27 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/ptableType +``` + +Partition table type. + +> The partition table is created only if all the current partitions are deleted. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## ptableType Type + +unknown + +## ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-partitioneddrive.md b/docs/user/unattended/reference/storage-1-defs-partitioneddrive.md new file mode 100644 index 0000000..3e70c37 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitioneddrive.md @@ -0,0 +1,116 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## partitionedDrive Type + +`object` ([Details](storage-1-defs-partitioneddrive.md)) + +# partitionedDrive Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search) | Merged | Optional | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/search") | +| [alias](#alias) | `string` | Optional | cannot be null | [Config](storage-1-defs-partitioneddrive-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/alias") | +| [ptableType](#ptabletype) | Not specified | Optional | cannot be null | [Config](storage-1-defs-partitioneddrive-properties-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/ptableType") | +| [partitions](#partitions) | `array` | Optional | cannot be null | [Config](storage-1-defs-partitioneddrive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/partitions") | + +## search + + + +`search` + +* is optional + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/search") + +### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-searchelement-anyof-0.md "check type definition") + +* [Untitled string in Config](storage-1-defs-searchelement-anyof-1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +## alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-partitioneddrive-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/alias") + +### alias Type + +`string` + +## ptableType + +Partition table type. + +> The partition table is created only if all the current partitions are deleted. + +`ptableType` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-partitioneddrive-properties-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/ptableType") + +### ptableType Type + +unknown + +### ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | + +## partitions + + + +`partitions` + +* is optional + +* Type: an array of merged types ([Details](storage-1-defs-partitioneddrive-properties-partitions-items.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-partitioneddrive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/partitions") + +### partitions Type + +an array of merged types ([Details](storage-1-defs-partitioneddrive-properties-partitions-items.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-partitionelement.md b/docs/user/unattended/reference/storage-1-defs-partitionelement.md new file mode 100644 index 0000000..7d1f9f9 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitionelement.md @@ -0,0 +1,27 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionElement +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## partitionElement Type + +merged type ([Details](storage-1-defs-partitionelement.md)) + +any of + +* [Untitled object in Config](storage-1-defs-simplevolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedpartitionsgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-regularpartition.md "check type definition") + +* [Untitled object in Config](storage-1-defs-partitiontodelete.md "check type definition") + +* [Untitled object in Config](storage-1-defs-partitiontodeleteifneeded.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-partitiontodelete-properties-delete.md b/docs/user/unattended/reference/storage-1-defs-partitiontodelete-properties-delete.md new file mode 100644 index 0000000..637c022 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitiontodelete-properties-delete.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/delete +``` + +Delete the partition. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## delete Type + +unknown + +## delete Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` diff --git a/docs/user/unattended/reference/storage-1-defs-partitiontodelete.md b/docs/user/unattended/reference/storage-1-defs-partitiontodelete.md new file mode 100644 index 0000000..5b99a59 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitiontodelete.md @@ -0,0 +1,74 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## partitionToDelete Type + +`object` ([Details](storage-1-defs-partitiontodelete.md)) + +# partitionToDelete Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search) | Merged | Required | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/search") | +| [delete](#delete) | Not specified | Required | cannot be null | [Config](storage-1-defs-partitiontodelete-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/delete") | + +## search + + + +`search` + +* is required + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/search") + +### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-searchelement-anyof-0.md "check type definition") + +* [Untitled string in Config](storage-1-defs-searchelement-anyof-1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +## delete + +Delete the partition. + +`delete` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-partitiontodelete-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/delete") + +### delete Type + +unknown + +### delete Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` diff --git a/docs/user/unattended/reference/storage-1-defs-partitiontodeleteifneeded-properties-deleteifneeded.md b/docs/user/unattended/reference/storage-1-defs-partitiontodeleteifneeded-properties-deleteifneeded.md new file mode 100644 index 0000000..f30af9b --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitiontodeleteifneeded-properties-deleteifneeded.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/deleteIfNeeded +``` + +Delete the partition if needed to make space. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## deleteIfNeeded Type + +unknown + +## deleteIfNeeded Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` diff --git a/docs/user/unattended/reference/storage-1-defs-partitiontodeleteifneeded.md b/docs/user/unattended/reference/storage-1-defs-partitiontodeleteifneeded.md new file mode 100644 index 0000000..426c7d8 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-partitiontodeleteifneeded.md @@ -0,0 +1,105 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## PartitionToDeleteIfNeeded Type + +`object` ([Details](storage-1-defs-partitiontodeleteifneeded.md)) + +# PartitionToDeleteIfNeeded Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search) | Merged | Required | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/search") | +| [deleteIfNeeded](#deleteifneeded) | Not specified | Required | cannot be null | [Config](storage-1-defs-partitiontodeleteifneeded-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/deleteIfNeeded") | +| [size](#size) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/size") | + +## search + + + +`search` + +* is required + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/search") + +### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-searchelement-anyof-0.md "check type definition") + +* [Untitled string in Config](storage-1-defs-searchelement-anyof-1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +## deleteIfNeeded + +Delete the partition if needed to make space. + +`deleteIfNeeded` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-partitiontodeleteifneeded-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/deleteIfNeeded") + +### deleteIfNeeded Type + +unknown + +### deleteIfNeeded Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` + +## size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/size") + +### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-physicalvolumeelement-anyof-0.md b/docs/user/unattended/reference/storage-1-defs-physicalvolumeelement-anyof-0.md new file mode 100644 index 0000000..c42d3dc --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-physicalvolumeelement-anyof-0.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/physicalVolumeElement/anyOf/0 +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 0 Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-physicalvolumeelement.md b/docs/user/unattended/reference/storage-1-defs-physicalvolumeelement.md new file mode 100644 index 0000000..8b1c3a3 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-physicalvolumeelement.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/physicalVolumeElement +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## physicalVolumeElement Type + +merged type ([Details](storage-1-defs-physicalvolumeelement.md)) + +any of + +* [Untitled string in Config](storage-1-defs-physicalvolumeelement-anyof-0.md "check type definition") + +* [Untitled object in Config](storage-1-defs-simplephysicalvolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedphysicalvolumesgenerator.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-ptabletype.md b/docs/user/unattended/reference/storage-1-defs-ptabletype.md new file mode 100644 index 0000000..bc0494b --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-ptabletype.md @@ -0,0 +1,27 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/ptableType +``` + +Partition table type. + +> The partition table is created only if all the current partitions are deleted. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## ptableType Type + +unknown + +## ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-regularpartition-properties-alias.md b/docs/user/unattended/reference/storage-1-defs-regularpartition-properties-alias.md new file mode 100644 index 0000000..3d2166e --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-regularpartition-properties-alias.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/alias +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## alias Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-regularpartition-properties-partition-id.md b/docs/user/unattended/reference/storage-1-defs-regularpartition-properties-partition-id.md new file mode 100644 index 0000000..e60fdf0 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-regularpartition-properties-partition-id.md @@ -0,0 +1,29 @@ +# Partition id Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/id +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## id Type + +unknown ([Partition id](storage-1-defs-regularpartition-properties-partition-id.md)) + +## id Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"linux"` | | +| `"swap"` | | +| `"lvm"` | | +| `"raid"` | | +| `"esp"` | | +| `"prep"` | | +| `"bios_boot"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-regularpartition.md b/docs/user/unattended/reference/storage-1-defs-regularpartition.md new file mode 100644 index 0000000..1e5a930 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-regularpartition.md @@ -0,0 +1,180 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## regularPartition Type + +`object` ([Details](storage-1-defs-regularpartition.md)) + +# regularPartition Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search) | Merged | Optional | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/search") | +| [alias](#alias) | `string` | Optional | cannot be null | [Config](storage-1-defs-regularpartition-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/alias") | +| [id](#id) | Not specified | Optional | cannot be null | [Config](storage-1-defs-regularpartition-properties-partition-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/id") | +| [size](#size) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/size") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/encryption") | +| [filesystem](#filesystem) | `object` | Optional | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/filesystem") | + +## search + + + +`search` + +* is optional + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/search") + +### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-searchelement-anyof-0.md "check type definition") + +* [Untitled string in Config](storage-1-defs-searchelement-anyof-1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +## alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-regularpartition-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/alias") + +### alias Type + +`string` + +## id + + + +`id` + +* is optional + +* Type: unknown ([Partition id](storage-1-defs-regularpartition-properties-partition-id.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-regularpartition-properties-partition-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/id") + +### id Type + +unknown ([Partition id](storage-1-defs-regularpartition-properties-partition-id.md)) + +### id Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"linux"` | | +| `"swap"` | | +| `"lvm"` | | +| `"raid"` | | +| `"esp"` | | +| `"prep"` | | +| `"bios_boot"` | | + +## size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/size") + +### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") + +## filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/filesystem") + +### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-searchelement-anyof-0.md b/docs/user/unattended/reference/storage-1-defs-searchelement-anyof-0.md new file mode 100644 index 0000000..ff2e267 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-searchelement-anyof-0.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/searchElement/anyOf/0 +``` + +Shortcut to match all devices if there is any (equivalent to specify no conditions and to skip the entry if no device is found). + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 0 Type + +unknown + +## 0 Constraints + +**constant**: the value of this property must be equal to: + +```json +"*" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-searchelement-anyof-1.md b/docs/user/unattended/reference/storage-1-defs-searchelement-anyof-1.md new file mode 100644 index 0000000..5aa45b5 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-searchelement-anyof-1.md @@ -0,0 +1,25 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/searchElement/anyOf/1 +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 1 Type + +`string` + +## 1 Examples + +```json +"/dev/vda" +``` + +```json +"/dev/disk/by-id/ata-WDC_WD3200AAKS-75L9" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-searchelement.md b/docs/user/unattended/reference/storage-1-defs-searchelement.md new file mode 100644 index 0000000..bb2865f --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-searchelement.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/searchElement +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## searchElement Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-searchelement-anyof-0.md "check type definition") + +* [Untitled string in Config](storage-1-defs-searchelement-anyof-1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator-properties-generate-items.md b/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator-properties-generate-items.md new file mode 100644 index 0000000..e2604d3 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator-properties-generate-items.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator/properties/generate/items +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md b/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md new file mode 100644 index 0000000..4bf2f36 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator/properties/generate +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## generate Type + +`string[]` diff --git a/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator.md b/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator.md new file mode 100644 index 0000000..cc024d6 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-simplephysicalvolumesgenerator.md @@ -0,0 +1,39 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator +``` + +Automatically creates the needed physical volumes in the indicated devices. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## simplePhysicalVolumesGenerator Type + +`object` ([Details](storage-1-defs-simplephysicalvolumesgenerator.md)) + +# simplePhysicalVolumesGenerator Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate) | `array` | Required | cannot be null | [Config](storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator/properties/generate") | + +## generate + + + +`generate` + +* is required + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator/properties/generate") + +### generate Type + +`string[]` diff --git a/docs/user/unattended/reference/storage-1-defs-simplesearchall.md b/docs/user/unattended/reference/storage-1-defs-simplesearchall.md new file mode 100644 index 0000000..1970cd2 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-simplesearchall.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleSearchAll +``` + +Shortcut to match all devices if there is any (equivalent to specify no conditions and to skip the entry if no device is found). + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## simpleSearchAll Type + +unknown + +## simpleSearchAll Constraints + +**constant**: the value of this property must be equal to: + +```json +"*" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-simplesearchbyname.md b/docs/user/unattended/reference/storage-1-defs-simplesearchbyname.md new file mode 100644 index 0000000..ffcf01a --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-simplesearchbyname.md @@ -0,0 +1,25 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleSearchByName +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## simpleSearchByName Type + +`string` + +## simpleSearchByName Examples + +```json +"/dev/vda" +``` + +```json +"/dev/disk/by-id/ata-WDC_WD3200AAKS-75L9" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-simplevolumesgenerator-properties-generate.md b/docs/user/unattended/reference/storage-1-defs-simplevolumesgenerator-properties-generate.md new file mode 100644 index 0000000..4682f34 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-simplevolumesgenerator-properties-generate.md @@ -0,0 +1,24 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator/properties/generate +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## generate Type + +unknown + +## generate Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"default"` | | +| `"mandatory"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-simplevolumesgenerator.md b/docs/user/unattended/reference/storage-1-defs-simplevolumesgenerator.md new file mode 100644 index 0000000..5c8adb2 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-simplevolumesgenerator.md @@ -0,0 +1,48 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator +``` + +Automatically creates the default or mandatory volumes configured by the selected product. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## simpleVolumesGenerator Type + +`object` ([Details](storage-1-defs-simplevolumesgenerator.md)) + +# simpleVolumesGenerator Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate) | Not specified | Required | cannot be null | [Config](storage-1-defs-simplevolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator/properties/generate") | + +## generate + + + +`generate` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-simplevolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator/properties/generate") + +### generate Type + +unknown + +### generate Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"default"` | | +| `"mandatory"` | | diff --git a/docs/user/unattended/reference/storage-1-defs-size-anyof-size-range.md b/docs/user/unattended/reference/storage-1-defs-size-anyof-size-range.md new file mode 100644 index 0000000..5562a50 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-size-anyof-size-range.md @@ -0,0 +1,78 @@ +# Size range Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/2 +``` + +Size range. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 2 Type + +`object` ([Size range](storage-1-defs-size-anyof-size-range.md)) + +# 2 Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------- | :----- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [min](#min) | Merged | Required | cannot be null | [Config](storage-1-defs-sizevaluewithcurrent.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/2/properties/min") | +| [max](#max) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevaluewithcurrent.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/2/properties/max") | + +## min + + + +`min` + +* is required + +* Type: merged type ([Details](storage-1-defs-sizevaluewithcurrent.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevaluewithcurrent.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/2/properties/min") + +### min Type + +merged type ([Details](storage-1-defs-sizevaluewithcurrent.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size current](storage-1-defs-sizevaluewithcurrent-anyof-size-current.md "check type definition") + +## max + + + +`max` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevaluewithcurrent.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevaluewithcurrent.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/2/properties/max") + +### max Type + +merged type ([Details](storage-1-defs-sizevaluewithcurrent.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size current](storage-1-defs-sizevaluewithcurrent-anyof-size-current.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-size-anyof-size-tuple-items.md b/docs/user/unattended/reference/storage-1-defs-size-anyof-size-tuple-items.md new file mode 100644 index 0000000..654b999 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-size-anyof-size-tuple-items.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/1/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +merged type ([Details](storage-1-defs-size-anyof-size-tuple-items.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size current](storage-1-defs-sizevaluewithcurrent-anyof-size-current.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-size-anyof-size-tuple.md b/docs/user/unattended/reference/storage-1-defs-size-anyof-size-tuple.md new file mode 100644 index 0000000..57ba85b --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-size-anyof-size-tuple.md @@ -0,0 +1,50 @@ +# Size tuple Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size/anyOf/1 +``` + +Lower size limit and optionally upper size limit. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 1 Type + +an array of merged types ([Details](storage-1-defs-size-anyof-size-tuple-items.md)) + +## 1 Constraints + +**maximum number of items**: the maximum number of items for this array is: `2` + +**minimum number of items**: the minimum number of items for this array is: `1` + +## 1 Examples + +```json +[ + 1024, + "current" +] +``` + +```json +[ + "1 GiB", + "5 GiB" +] +``` + +```json +[ + 1024, + "2 GiB" +] +``` + +```json +[ + "2 GiB" +] +``` diff --git a/docs/user/unattended/reference/storage-1-defs-size.md b/docs/user/unattended/reference/storage-1-defs-size.md new file mode 100644 index 0000000..837b36f --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-size.md @@ -0,0 +1,27 @@ +# Size Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-sizebytes.md b/docs/user/unattended/reference/storage-1-defs-sizebytes.md new file mode 100644 index 0000000..751e490 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-sizebytes.md @@ -0,0 +1,29 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeBytes +``` + +Size in bytes. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## sizeBytes Type + +`integer` + +## sizeBytes Constraints + +**minimum**: the value of this number must greater than or equal to: `0` + +## sizeBytes Examples + +```json +1024 +``` + +```json +2048 +``` diff --git a/docs/user/unattended/reference/storage-1-defs-sizestring.md b/docs/user/unattended/reference/storage-1-defs-sizestring.md new file mode 100644 index 0000000..452b3bf --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-sizestring.md @@ -0,0 +1,47 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeString +``` + +Human readable size. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## sizeString Type + +`string` + +## sizeString Constraints + +**pattern**: the string must match the following regular expression: + +```regexp +^[0-9]+(\.[0-9]+)?(\s*([KkMmGgTtPpEeZzYy][iI]?)?[Bb])?$ +``` + +[try pattern](https://regexr.com/?expression=%5E%5B0-9%5D%2B\(%5C.%5B0-9%5D%2B\)%3F\(%5Cs*\(%5BKkMmGgTtPpEeZzYy%5D%5BiI%5D%3F\)%3F%5BBb%5D\)%3F%24 "try regular expression with regexr.com") + +## sizeString Examples + +```json +"2 GiB" +``` + +```json +"1.5 TB" +``` + +```json +"1TIB" +``` + +```json +"1073741824 b" +``` + +```json +"1073741824" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-sizevalue-anyof-0.md b/docs/user/unattended/reference/storage-1-defs-sizevalue-anyof-0.md new file mode 100644 index 0000000..2c681b0 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-sizevalue-anyof-0.md @@ -0,0 +1,47 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeValue/anyOf/0 +``` + +Human readable size. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 0 Type + +`string` + +## 0 Constraints + +**pattern**: the string must match the following regular expression: + +```regexp +^[0-9]+(\.[0-9]+)?(\s*([KkMmGgTtPpEeZzYy][iI]?)?[Bb])?$ +``` + +[try pattern](https://regexr.com/?expression=%5E%5B0-9%5D%2B\(%5C.%5B0-9%5D%2B\)%3F\(%5Cs*\(%5BKkMmGgTtPpEeZzYy%5D%5BiI%5D%3F\)%3F%5BBb%5D\)%3F%24 "try regular expression with regexr.com") + +## 0 Examples + +```json +"2 GiB" +``` + +```json +"1.5 TB" +``` + +```json +"1TIB" +``` + +```json +"1073741824 b" +``` + +```json +"1073741824" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-sizevalue-anyof-1.md b/docs/user/unattended/reference/storage-1-defs-sizevalue-anyof-1.md new file mode 100644 index 0000000..d20c2d7 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-sizevalue-anyof-1.md @@ -0,0 +1,29 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeValue/anyOf/1 +``` + +Size in bytes. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 1 Type + +`integer` + +## 1 Constraints + +**minimum**: the value of this number must greater than or equal to: `0` + +## 1 Examples + +```json +1024 +``` + +```json +2048 +``` diff --git a/docs/user/unattended/reference/storage-1-defs-sizevalue.md b/docs/user/unattended/reference/storage-1-defs-sizevalue.md new file mode 100644 index 0000000..fbf8e61 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-sizevalue.md @@ -0,0 +1,21 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeValue +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## sizeValue Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-sizevaluewithcurrent-anyof-size-current.md b/docs/user/unattended/reference/storage-1-defs-sizevaluewithcurrent-anyof-size-current.md new file mode 100644 index 0000000..6b5c314 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-sizevaluewithcurrent-anyof-size-current.md @@ -0,0 +1,23 @@ +# Size current Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeValueWithCurrent/anyOf/1 +``` + +The current size of the device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## 1 Type + +unknown ([Size current](storage-1-defs-sizevaluewithcurrent-anyof-size-current.md)) + +## 1 Constraints + +**constant**: the value of this property must be equal to: + +```json +"current" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-sizevaluewithcurrent.md b/docs/user/unattended/reference/storage-1-defs-sizevaluewithcurrent.md new file mode 100644 index 0000000..8a87090 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-sizevaluewithcurrent.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeValueWithCurrent +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## sizeValueWithCurrent Type + +merged type ([Details](storage-1-defs-sizevaluewithcurrent.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size current](storage-1-defs-sizevaluewithcurrent-anyof-size-current.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume-properties-name.md b/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume-properties-name.md new file mode 100644 index 0000000..08f6b2c --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume-properties-name.md @@ -0,0 +1,21 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/name +``` + +Thin logical volume name. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## name Type + +`string` + +## name Examples + +```json +"lv0" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume-properties-usedpool.md b/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume-properties-usedpool.md new file mode 100644 index 0000000..053ff0f --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume-properties-usedpool.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/usedPool +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## usedPool Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume.md b/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume.md new file mode 100644 index 0000000..d4d8d59 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinlogicalvolume.md @@ -0,0 +1,145 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## thinLogicalVolume Type + +`object` ([Details](storage-1-defs-thinlogicalvolume.md)) + +# thinLogicalVolume Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [name](#name) | `string` | Optional | cannot be null | [Config](storage-1-defs-thinlogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/name") | +| [size](#size) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/size") | +| [usedPool](#usedpool) | `string` | Required | cannot be null | [Config](storage-1-defs-thinlogicalvolume-properties-usedpool.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/usedPool") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/encryption") | +| [filesystem](#filesystem) | `object` | Optional | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/filesystem") | + +## name + +Thin logical volume name. + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-thinlogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/name") + +### name Type + +`string` + +### name Examples + +```json +"lv0" +``` + +## size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/size") + +### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +## usedPool + +Alias used to reference a device. + +`usedPool` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-thinlogicalvolume-properties-usedpool.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/usedPool") + +### usedPool Type + +`string` + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") + +## filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/filesystem") + +### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-alias.md b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-alias.md new file mode 100644 index 0000000..205e028 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-alias.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/alias +``` + +Alias used to reference a device. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## alias Type + +`string` diff --git a/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-name.md b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-name.md new file mode 100644 index 0000000..ad4b1c0 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-name.md @@ -0,0 +1,21 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/name +``` + +Logical volume name. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## name Type + +`string` + +## name Examples + +```json +"lv0" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-pool.md b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-pool.md new file mode 100644 index 0000000..f6b7e4c --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-pool.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/pool +``` + +LVM thin pool. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## pool Type + +unknown + +## pool Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` diff --git a/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-stripes.md b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-stripes.md new file mode 100644 index 0000000..c4e611d --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume-properties-stripes.md @@ -0,0 +1,21 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripes +``` + +Number of stripes. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## stripes Type + +`integer` + +## stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` diff --git a/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume.md b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume.md new file mode 100644 index 0000000..c04b83b --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-thinpoollogicalvolume.md @@ -0,0 +1,203 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## thinPoolLogicalVolume Type + +`object` ([Details](storage-1-defs-thinpoollogicalvolume.md)) + +# thinPoolLogicalVolume Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [pool](#pool) | Not specified | Required | cannot be null | [Config](storage-1-defs-thinpoollogicalvolume-properties-pool.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/pool") | +| [alias](#alias) | `string` | Optional | cannot be null | [Config](storage-1-defs-thinpoollogicalvolume-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/alias") | +| [name](#name) | `string` | Optional | cannot be null | [Config](storage-1-defs-thinpoollogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/name") | +| [size](#size) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/size") | +| [stripes](#stripes) | `integer` | Optional | cannot be null | [Config](storage-1-defs-thinpoollogicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripes") | +| [stripeSize](#stripesize) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripeSize") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/encryption") | + +## pool + +LVM thin pool. + +`pool` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-thinpoollogicalvolume-properties-pool.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/pool") + +### pool Type + +unknown + +### pool Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` + +## alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-thinpoollogicalvolume-properties-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/alias") + +### alias Type + +`string` + +## name + +Logical volume name. + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-thinpoollogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/name") + +### name Type + +`string` + +### name Examples + +```json +"lv0" +``` + +## size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/size") + +### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +## stripes + +Number of stripes. + +`stripes` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-thinpoollogicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripes") + +### stripes Type + +`integer` + +### stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` + +## stripeSize + + + +`stripeSize` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevalue.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripeSize") + +### stripeSize Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +## encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/encryption") + +### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryption-anyof-4.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-logicalvolumes-items.md b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-logicalvolumes-items.md new file mode 100644 index 0000000..47dc933 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-logicalvolumes-items.md @@ -0,0 +1,27 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/logicalVolumes/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +merged type ([Details](storage-1-defs-volumegroup-properties-logicalvolumes-items.md)) + +any of + +* [Untitled object in Config](storage-1-defs-simplevolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedlogicalvolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-logicalvolume.md "check type definition") + +* [Untitled object in Config](storage-1-defs-thinpoollogicalvolume.md "check type definition") + +* [Untitled object in Config](storage-1-defs-thinlogicalvolume.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-logicalvolumes.md b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-logicalvolumes.md new file mode 100644 index 0000000..6d833f0 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-logicalvolumes.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/logicalVolumes +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## logicalVolumes Type + +an array of merged types ([Details](storage-1-defs-volumegroup-properties-logicalvolumes-items.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-name.md b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-name.md new file mode 100644 index 0000000..4f83655 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-name.md @@ -0,0 +1,21 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/name +``` + +Volume group name. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## name Type + +`string` + +## name Examples + +```json +"vg0" +``` diff --git a/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-physicalvolumes-items.md b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-physicalvolumes-items.md new file mode 100644 index 0000000..d64050c --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-physicalvolumes-items.md @@ -0,0 +1,23 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/physicalVolumes/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +merged type ([Details](storage-1-defs-volumegroup-properties-physicalvolumes-items.md)) + +any of + +* [Untitled string in Config](storage-1-defs-physicalvolumeelement-anyof-0.md "check type definition") + +* [Untitled object in Config](storage-1-defs-simplephysicalvolumesgenerator.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedphysicalvolumesgenerator.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-physicalvolumes.md b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-physicalvolumes.md new file mode 100644 index 0000000..aca26e5 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-volumegroup-properties-physicalvolumes.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/physicalVolumes +``` + +Devices to use as physical volumes. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## physicalVolumes Type + +an array of merged types ([Details](storage-1-defs-volumegroup-properties-physicalvolumes-items.md)) diff --git a/docs/user/unattended/reference/storage-1-defs-volumegroup.md b/docs/user/unattended/reference/storage-1-defs-volumegroup.md new file mode 100644 index 0000000..45617bd --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs-volumegroup.md @@ -0,0 +1,108 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup +``` + +LVM volume group. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## volumeGroup Type + +`object` ([Details](storage-1-defs-volumegroup.md)) + +# volumeGroup Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Required | cannot be null | [Config](storage-1-defs-volumegroup-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/name") | +| [extentSize](#extentsize) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/extentSize") | +| [physicalVolumes](#physicalvolumes) | `array` | Optional | cannot be null | [Config](storage-1-defs-volumegroup-properties-physicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/physicalVolumes") | +| [logicalVolumes](#logicalvolumes) | `array` | Optional | cannot be null | [Config](storage-1-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/logicalVolumes") | + +## name + +Volume group name. + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-volumegroup-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/name") + +### name Type + +`string` + +### name Examples + +```json +"vg0" +``` + +## extentSize + + + +`extentSize` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevalue.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/extentSize") + +### extentSize Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizevalue-anyof-0.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizevalue-anyof-1.md "check type definition") + +## physicalVolumes + +Devices to use as physical volumes. + +`physicalVolumes` + +* is optional + +* Type: an array of merged types ([Details](storage-1-defs-physicalvolumeelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-volumegroup-properties-physicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/physicalVolumes") + +### physicalVolumes Type + +an array of merged types ([Details](storage-1-defs-physicalvolumeelement.md)) + +## logicalVolumes + + + +`logicalVolumes` + +* is optional + +* Type: an array of merged types ([Details](storage-1-defs-volumegroup-properties-logicalvolumes-items.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/logicalVolumes") + +### logicalVolumes Type + +an array of merged types ([Details](storage-1-defs-volumegroup-properties-logicalvolumes-items.md)) diff --git a/docs/user/unattended/reference/storage-1-defs.md b/docs/user/unattended/reference/storage-1-defs.md new file mode 100644 index 0000000..68d2a12 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-defs.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## $defs Type + +unknown diff --git a/docs/user/unattended/reference/storage-1-properties-drives-items.md b/docs/user/unattended/reference/storage-1-properties-drives-items.md new file mode 100644 index 0000000..9595a05 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-properties-drives-items.md @@ -0,0 +1,21 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/drives/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## items Type + +merged type ([Details](storage-1-properties-drives-items.md)) + +any of + +* [Untitled object in Config](storage-1-defs-formatteddrive.md "check type definition") + +* [Untitled object in Config](storage-1-defs-partitioneddrive.md "check type definition") diff --git a/docs/user/unattended/reference/storage-1-properties-drives.md b/docs/user/unattended/reference/storage-1-properties-drives.md new file mode 100644 index 0000000..9fe2790 --- /dev/null +++ b/docs/user/unattended/reference/storage-1-properties-drives.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/drives +``` + +Drives (disks, BIOS RAIDs and multipath devices). + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## drives Type + +an array of merged types ([Details](storage-1-properties-drives-items.md)) diff --git a/docs/user/unattended/reference/storage-1-properties-volumegroups.md b/docs/user/unattended/reference/storage-1-properties-volumegroups.md new file mode 100644 index 0000000..e39b02f --- /dev/null +++ b/docs/user/unattended/reference/storage-1-properties-volumegroups.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/volumeGroups +``` + +LVM volume groups. + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.schema.json\*](storage.schema.json "open original schema") | + +## volumeGroups Type + +`object[]` ([Details](storage-1-defs-volumegroup.md)) diff --git a/docs/user/unattended/reference/storage-1.md b/docs/user/unattended/reference/storage-1.md new file mode 100644 index 0000000..aa2a4cd --- /dev/null +++ b/docs/user/unattended/reference/storage-1.md @@ -0,0 +1,2091 @@ +# Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json +``` + +Storage config. + +> Based on doc/auto\_storage.md + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.schema.json](storage.schema.json "open original schema") | + +## Config Type + +`object` ([Config](storage-1.md)) + +# Config Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [boot](#boot) | `object` | Optional | cannot be null | [Config](storage-1-defs-boot.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/boot") | +| [drives](#drives) | `array` | Optional | cannot be null | [Config](storage-1-properties-drives.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/drives") | +| [volumeGroups](#volumegroups) | `array` | Optional | cannot be null | [Config](storage-1-properties-volumegroups.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/volumeGroups") | + +## boot + +Allows configuring boot partitions automatically. + +`boot` + +* is optional + +* Type: `object` ([Details](storage-1-defs-boot.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-boot.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/boot") + +### boot Type + +`object` ([Details](storage-1-defs-boot.md)) + +## drives + +Drives (disks, BIOS RAIDs and multipath devices). + +`drives` + +* is optional + +* Type: an array of merged types ([Details](storage-1-defs-driveelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-properties-drives.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/drives") + +### drives Type + +an array of merged types ([Details](storage-1-defs-driveelement.md)) + +## volumeGroups + +LVM volume groups. + +`volumeGroups` + +* is optional + +* Type: `object[]` ([Details](storage-1-defs-volumegroup.md)) + +* cannot be null + +* defined in: [Config](storage-1-properties-volumegroups.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/properties/volumeGroups") + +### volumeGroups Type + +`object[]` ([Details](storage-1-defs-volumegroup.md)) + +# Config Definitions + +## Definitions group boot + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [configure](#configure) | `boolean` | Required | cannot be null | [Config](storage-1-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/configure") | +| [device](#device) | `string` | Optional | cannot be null | [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/device") | + +### configure + +Whether to configure partitions for booting. + +`configure` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-1-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/configure") + +#### configure Type + +`boolean` + +### device + +Alias used to reference a device. + +`device` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/boot/properties/device") + +#### device Type + +`string` + +## Definitions group driveElement + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/driveElement"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group formattedDrive + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search) | Merged | Optional | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/search") | +| [alias](#alias) | `string` | Optional | cannot be null | [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/alias") | +| [encryption](#encryption) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/encryption") | +| [filesystem](#filesystem) | `object` | Required | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/filesystem") | + +### search + + + +`search` + +* is optional + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/search") + +#### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-simplesearchall.md "check type definition") + +* [Untitled string in Config](storage-1-defs-simplesearchbyname.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +### alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/alias") + +#### alias Type + +`string` + +### encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/encryption") + +#### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryptionswap.md "check type definition") + +### filesystem + + + +`filesystem` + +* is required + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/formattedDrive/properties/filesystem") + +#### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) + +## Definitions group partitionedDrive + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search-1) | Merged | Optional | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/search") | +| [alias](#alias-1) | `string` | Optional | cannot be null | [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/alias") | +| [ptableType](#ptabletype) | Not specified | Optional | cannot be null | [Config](storage-1-defs-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/ptableType") | +| [partitions](#partitions) | `array` | Optional | cannot be null | [Config](storage-1-defs-partitioneddrive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/partitions") | + +### search + + + +`search` + +* is optional + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/search") + +#### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-simplesearchall.md "check type definition") + +* [Untitled string in Config](storage-1-defs-simplesearchbyname.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +### alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/alias") + +#### alias Type + +`string` + +### ptableType + +Partition table type. + +> The partition table is created only if all the current partitions are deleted. + +`ptableType` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/ptableType") + +#### ptableType Type + +unknown + +#### ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | + +### partitions + + + +`partitions` + +* is optional + +* Type: an array of merged types ([Details](storage-1-defs-partitionelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-partitioneddrive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionedDrive/properties/partitions") + +#### partitions Type + +an array of merged types ([Details](storage-1-defs-partitionelement.md)) + +## Definitions group ptableType + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/ptableType"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group partitionElement + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionElement"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group simpleVolumesGenerator + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate) | Not specified | Required | cannot be null | [Config](storage-1-defs-simplevolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator/properties/generate") | + +### generate + + + +`generate` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-simplevolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleVolumesGenerator/properties/generate") + +#### generate Type + +unknown + +#### generate Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"default"` | | +| `"mandatory"` | | + +## Definitions group advancedPartitionsGenerator + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate-1) | `object` | Required | cannot be null | [Config](storage-1-defs-advancedpartitionsgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate") | + +### generate + + + +`generate` + +* is required + +* Type: `object` ([Details](storage-1-defs-advancedpartitionsgenerator-properties-generate.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedpartitionsgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPartitionsGenerator/properties/generate") + +#### generate Type + +`object` ([Details](storage-1-defs-advancedpartitionsgenerator-properties-generate.md)) + +## Definitions group regularPartition + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search-2) | Merged | Optional | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/search") | +| [alias](#alias-2) | `string` | Optional | cannot be null | [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/alias") | +| [id](#id) | Not specified | Optional | cannot be null | [Config](storage-1-defs-regularpartition-properties-partition-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/id") | +| [size](#size) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/size") | +| [encryption](#encryption-1) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/encryption") | +| [filesystem](#filesystem-1) | `object` | Optional | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/filesystem") | + +### search + + + +`search` + +* is optional + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/search") + +#### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-simplesearchall.md "check type definition") + +* [Untitled string in Config](storage-1-defs-simplesearchbyname.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +### alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/alias") + +#### alias Type + +`string` + +### id + + + +`id` + +* is optional + +* Type: unknown ([Partition id](storage-1-defs-regularpartition-properties-partition-id.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-regularpartition-properties-partition-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/id") + +#### id Type + +unknown ([Partition id](storage-1-defs-regularpartition-properties-partition-id.md)) + +#### id Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"linux"` | | +| `"swap"` | | +| `"lvm"` | | +| `"raid"` | | +| `"esp"` | | +| `"prep"` | | +| `"bios_boot"` | | + +### size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/size") + +#### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +### encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/encryption") + +#### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryptionswap.md "check type definition") + +### filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/regularPartition/properties/filesystem") + +#### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) + +## Definitions group partitionToDelete + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search-3) | Merged | Required | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/search") | +| [delete](#delete) | Not specified | Required | cannot be null | [Config](storage-1-defs-partitiontodelete-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/delete") | + +### search + + + +`search` + +* is required + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/search") + +#### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-simplesearchall.md "check type definition") + +* [Untitled string in Config](storage-1-defs-simplesearchbyname.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +### delete + +Delete the partition. + +`delete` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-partitiontodelete-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/partitionToDelete/properties/delete") + +#### delete Type + +unknown + +#### delete Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` + +## Definitions group PartitionToDeleteIfNeeded + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [search](#search-4) | Merged | Required | cannot be null | [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/search") | +| [deleteIfNeeded](#deleteifneeded) | Not specified | Required | cannot be null | [Config](storage-1-defs-partitiontodeleteifneeded-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/deleteIfNeeded") | +| [size](#size-1) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/size") | + +### search + + + +`search` + +* is required + +* Type: merged type ([Details](storage-1-defs-searchelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-searchelement.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/search") + +#### search Type + +merged type ([Details](storage-1-defs-searchelement.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-simplesearchall.md "check type definition") + +* [Untitled string in Config](storage-1-defs-simplesearchbyname.md "check type definition") + +* [Untitled object in Config](storage-1-defs-advancedsearch.md "check type definition") + +### deleteIfNeeded + +Delete the partition if needed to make space. + +`deleteIfNeeded` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-partitiontodeleteifneeded-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/deleteIfNeeded") + +#### deleteIfNeeded Type + +unknown + +#### deleteIfNeeded Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` + +### size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/PartitionToDeleteIfNeeded/properties/size") + +#### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +## Definitions group volumeGroup + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Required | cannot be null | [Config](storage-1-defs-volumegroup-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/name") | +| [extentSize](#extentsize) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/extentSize") | +| [physicalVolumes](#physicalvolumes) | `array` | Optional | cannot be null | [Config](storage-1-defs-volumegroup-properties-physicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/physicalVolumes") | +| [logicalVolumes](#logicalvolumes) | `array` | Optional | cannot be null | [Config](storage-1-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/logicalVolumes") | + +### name + +Volume group name. + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-volumegroup-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/name") + +#### name Type + +`string` + +#### name Examples + +```json +"vg0" +``` + +### extentSize + + + +`extentSize` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevalue.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/extentSize") + +#### extentSize Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +### physicalVolumes + +Devices to use as physical volumes. + +`physicalVolumes` + +* is optional + +* Type: an array of merged types ([Details](storage-1-defs-physicalvolumeelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-volumegroup-properties-physicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/physicalVolumes") + +#### physicalVolumes Type + +an array of merged types ([Details](storage-1-defs-physicalvolumeelement.md)) + +### logicalVolumes + + + +`logicalVolumes` + +* is optional + +* Type: an array of merged types ([Details](storage-1-defs-logicalvolumeelement.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/volumeGroup/properties/logicalVolumes") + +#### logicalVolumes Type + +an array of merged types ([Details](storage-1-defs-logicalvolumeelement.md)) + +## Definitions group physicalVolumeElement + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/physicalVolumeElement"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group simplePhysicalVolumesGenerator + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate-2) | `array` | Required | cannot be null | [Config](storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator/properties/generate") | + +### generate + + + +`generate` + +* is required + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-1-defs-simplephysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simplePhysicalVolumesGenerator/properties/generate") + +#### generate Type + +`string[]` + +## Definitions group advancedPhysicalVolumesGenerator + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [generate](#generate-3) | `object` | Required | cannot be null | [Config](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate") | + +### generate + + + +`generate` + +* is required + +* Type: `object` ([Details](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedPhysicalVolumesGenerator/properties/generate") + +#### generate Type + +`object` ([Details](storage-1-defs-advancedphysicalvolumesgenerator-properties-generate.md)) + +## Definitions group logicalVolumeElement + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolumeElement"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group advancedLogicalVolumesGenerator + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [generate](#generate-4) | `object` | Required | cannot be null | [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate") | + +### generate + + + +`generate` + +* is required + +* Type: `object` ([Details](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedLogicalVolumesGenerator/properties/generate") + +#### generate Type + +`object` ([Details](storage-1-defs-advancedlogicalvolumesgenerator-properties-generate.md)) + +## Definitions group logicalVolume + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name-1) | `string` | Optional | cannot be null | [Config](storage-1-defs-logicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/name") | +| [size](#size-2) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/size") | +| [stripes](#stripes) | `integer` | Optional | cannot be null | [Config](storage-1-defs-logicalvolumestripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripes") | +| [stripeSize](#stripesize) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripeSize") | +| [encryption](#encryption-2) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/encryption") | +| [filesystem](#filesystem-2) | `object` | Optional | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/filesystem") | + +### name + +Logical volume name. + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-logicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/name") + +#### name Type + +`string` + +#### name Examples + +```json +"lv0" +``` + +### size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/size") + +#### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +### stripes + +Number of stripes. + +`stripes` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-logicalvolumestripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripes") + +#### stripes Type + +`integer` + +#### stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` + +### stripeSize + + + +`stripeSize` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevalue.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/stripeSize") + +#### stripeSize Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +### encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/encryption") + +#### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryptionswap.md "check type definition") + +### filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolume/properties/filesystem") + +#### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) + +## Definitions group thinPoolLogicalVolume + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [pool](#pool) | Not specified | Required | cannot be null | [Config](storage-1-defs-thinpoollogicalvolume-properties-pool.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/pool") | +| [alias](#alias-3) | `string` | Optional | cannot be null | [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/alias") | +| [name](#name-2) | `string` | Optional | cannot be null | [Config](storage-1-defs-thinpoollogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/name") | +| [size](#size-3) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/size") | +| [stripes](#stripes-1) | `integer` | Optional | cannot be null | [Config](storage-1-defs-logicalvolumestripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripes") | +| [stripeSize](#stripesize-1) | Merged | Optional | cannot be null | [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripeSize") | +| [encryption](#encryption-3) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/encryption") | + +### pool + +LVM thin pool. + +`pool` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-1-defs-thinpoollogicalvolume-properties-pool.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/pool") + +#### pool Type + +unknown + +#### pool Constraints + +**constant**: the value of this property must be equal to: + +```json +true +``` + +### alias + +Alias used to reference a device. + +`alias` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/alias") + +#### alias Type + +`string` + +### name + +Logical volume name. + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-thinpoollogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/name") + +#### name Type + +`string` + +#### name Examples + +```json +"lv0" +``` + +### size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/size") + +#### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +### stripes + +Number of stripes. + +`stripes` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-logicalvolumestripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripes") + +#### stripes Type + +`integer` + +#### stripes Constraints + +**maximum**: the value of this number must smaller than or equal to: `128` + +**minimum**: the value of this number must greater than or equal to: `1` + +### stripeSize + + + +`stripeSize` + +* is optional + +* Type: merged type ([Details](storage-1-defs-sizevalue.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-sizevalue.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/stripeSize") + +#### stripeSize Type + +merged type ([Details](storage-1-defs-sizevalue.md)) + +any of + +* [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + +* [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +### encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinPoolLogicalVolume/properties/encryption") + +#### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryptionswap.md "check type definition") + +## Definitions group thinLogicalVolume + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name-3) | `string` | Optional | cannot be null | [Config](storage-1-defs-thinlogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/name") | +| [size](#size-4) | Merged | Optional | cannot be null | [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/size") | +| [usedPool](#usedpool) | `string` | Required | cannot be null | [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/usedPool") | +| [encryption](#encryption-4) | Merged | Optional | cannot be null | [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/encryption") | +| [filesystem](#filesystem-3) | `object` | Optional | cannot be null | [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/filesystem") | + +### name + +Thin logical volume name. + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-thinlogicalvolume-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/name") + +#### name Type + +`string` + +#### name Examples + +```json +"lv0" +``` + +### size + + + +`size` + +* is optional + +* Type: merged type ([Size](storage-1-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/size") + +#### size Type + +merged type ([Size](storage-1-defs-size.md)) + +any of + +* any of + + * [Untitled string in Config](storage-1-defs-sizestring.md "check type definition") + + * [Untitled integer in Config](storage-1-defs-sizebytes.md "check type definition") + +* [Size tuple](storage-1-defs-size-anyof-size-tuple.md "check type definition") + +* [Size range](storage-1-defs-size-anyof-size-range.md "check type definition") + +### usedPool + +Alias used to reference a device. + +`usedPool` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-alias.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/usedPool") + +#### usedPool Type + +`string` + +### encryption + + + +`encryption` + +* is optional + +* Type: merged type ([Details](storage-1-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/encryption") + +#### encryption Type + +merged type ([Details](storage-1-defs-encryption.md)) + +any of + +* [Untitled object in Config](storage-1-defs-encryptionluks1.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptionpervasiveluks2.md "check type definition") + +* [Untitled object in Config](storage-1-defs-encryptiontpm.md "check type definition") + +* [Untitled undefined type in Config](storage-1-defs-encryptionswap.md "check type definition") + +### filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-1-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/thinLogicalVolume/properties/filesystem") + +#### filesystem Type + +`object` ([Details](storage-1-defs-filesystem.md)) + +## Definitions group logicalVolumeStripes + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/logicalVolumeStripes"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group searchElement + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/searchElement"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group simpleSearchAll + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleSearchAll"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group simpleSearchByName + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/simpleSearchByName"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group advancedSearch + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [condition](#condition) | `object` | Optional | cannot be null | [Config](storage-1-defs-advancedsearch-properties-search-condition.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition") | +| [max](#max) | `integer` | Optional | cannot be null | [Config](storage-1-defs-advancedsearch-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/max") | +| [ifNotFound](#ifnotfound) | Not specified | Optional | cannot be null | [Config](storage-1-defs-advancedsearch-properties-search-action.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/ifNotFound") | + +### condition + + + +`condition` + +* is optional + +* Type: `object` ([Search condition](storage-1-defs-advancedsearch-properties-search-condition.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedsearch-properties-search-condition.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/condition") + +#### condition Type + +`object` ([Search condition](storage-1-defs-advancedsearch-properties-search-condition.md)) + +### max + +Maximum devices to match. + +`max` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedsearch-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/max") + +#### max Type + +`integer` + +#### max Constraints + +**minimum**: the value of this number must greater than or equal to: `1` + +### ifNotFound + +How to handle the section if the device is not found. + +`ifNotFound` + +* is optional + +* Type: unknown ([Search action](storage-1-defs-advancedsearch-properties-search-action.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-advancedsearch-properties-search-action.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/advancedSearch/properties/ifNotFound") + +#### ifNotFound Type + +unknown ([Search action](storage-1-defs-advancedsearch-properties-search-action.md)) + +#### ifNotFound Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"skip"` | | +| `"error"` | | + +#### ifNotFound Default Value + +The default value is: + +```json +"error" +``` + +## Definitions group alias + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/alias"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group size + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/size"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group sizeValue + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeValue"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group sizeValueWithCurrent + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeValueWithCurrent"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group sizeString + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeString"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group sizeBytes + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/sizeBytes"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group encryption + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryption"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group encryptionLuks1 + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [luks1](#luks1) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptionluks1-properties-luks1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1") | + +### luks1 + + + +`luks1` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptionluks1-properties-luks1.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks1-properties-luks1.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks1/properties/luks1") + +#### luks1 Type + +`object` ([Details](storage-1-defs-encryptionluks1-properties-luks1.md)) + +## Definitions group encryptionLuks2 + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [luks2](#luks2) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptionluks2-properties-luks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2") | + +### luks2 + + + +`luks2` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptionluks2-properties-luks2.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionluks2-properties-luks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionLuks2/properties/luks2") + +#### luks2 Type + +`object` ([Details](storage-1-defs-encryptionluks2-properties-luks2.md)) + +## Definitions group encryptionPervasiveLuks2 + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [pervasiveLuks2](#pervasiveluks2) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2") | + +### pervasiveLuks2 + + + +`pervasiveLuks2` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPervasiveLuks2/properties/pervasiveLuks2") + +#### pervasiveLuks2 Type + +`object` ([Details](storage-1-defs-encryptionpervasiveluks2-properties-pervasiveluks2.md)) + +## Definitions group encryptionTPM + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [tpmFde](#tpmfde) | `object` | Required | cannot be null | [Config](storage-1-defs-encryptiontpm-properties-tpmfde.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde") | + +### tpmFde + + + +`tpmFde` + +* is required + +* Type: `object` ([Details](storage-1-defs-encryptiontpm-properties-tpmfde.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-encryptiontpm-properties-tpmfde.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionTPM/properties/tpmFde") + +#### tpmFde Type + +`object` ([Details](storage-1-defs-encryptiontpm-properties-tpmfde.md)) + +## Definitions group encryptionSwap + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionSwap"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group encryptionPassword + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPassword"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group encryptionCipher + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionCipher"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group encryptionKeySize + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionKeySize"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group encryptionPbkdFunction + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/encryptionPbkdFunction"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group filesystem + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [reuseIfPossible](#reuseifpossible) | `boolean` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-reuseifpossible.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/reuseIfPossible") | +| [type](#type) | Merged | Optional | cannot be null | [Config](storage-1-defs-filesystemtype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/type") | +| [label](#label) | `string` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/label") | +| [path](#path) | `string` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-path.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/path") | +| [mountBy](#mountby) | Not specified | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-mount-by.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountBy") | +| [mkfsOptions](#mkfsoptions) | `array` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-mkfsoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mkfsOptions") | +| [mountOptions](#mountoptions) | `array` | Optional | cannot be null | [Config](storage-1-defs-filesystem-properties-mountoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountOptions") | + +### reuseIfPossible + +Try to reuse the existing file system. In some cases the file system could not be reused, for example, if the device is re-encrypted. + +`reuseIfPossible` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-reuseifpossible.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/reuseIfPossible") + +#### reuseIfPossible Type + +`boolean` + +### type + + + +`type` + +* is optional + +* Type: merged type ([Details](storage-1-defs-filesystemtype.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystemtype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/type") + +#### type Type + +merged type ([Details](storage-1-defs-filesystemtype.md)) + +any of + +* [Untitled undefined type in Config](storage-1-defs-filesystemtypeany.md "check type definition") + +* [Untitled object in Config](storage-1-defs-filesystemtypebtrfs.md "check type definition") + +### label + +File system label. + +`label` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/label") + +#### label Type + +`string` + +### path + +Mount path. + +`path` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-path.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/path") + +#### path Type + +`string` + +#### path Examples + +```json +"/var/log" +``` + +### mountBy + +How to mount the device. + +`mountBy` + +* is optional + +* Type: unknown ([Mount by](storage-1-defs-filesystem-properties-mount-by.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-mount-by.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountBy") + +#### mountBy Type + +unknown ([Mount by](storage-1-defs-filesystem-properties-mount-by.md)) + +#### mountBy Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"device"` | | +| `"id"` | | +| `"label"` | | +| `"path"` | | +| `"uuid"` | | + +### mkfsOptions + +Options for creating the file system. + +`mkfsOptions` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-mkfsoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mkfsOptions") + +#### mkfsOptions Type + +`string[]` + +### mountOptions + +Options to add to the fourth field of fstab. + +`mountOptions` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystem-properties-mountoptions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystem/properties/mountOptions") + +#### mountOptions Type + +`string[]` + +## Definitions group filesystemType + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemType"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group filesystemTypeAny + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeAny"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group filesystemTypeBtrfs + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [btrfs](#btrfs) | `object` | Required | cannot be null | [Config](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs") | + +### btrfs + + + +`btrfs` + +* is required + +* Type: `object` ([Details](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md)) + +* cannot be null + +* defined in: [Config](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json#/$defs/filesystemTypeBtrfs/properties/btrfs") + +#### btrfs Type + +`object` ([Details](storage-1-defs-filesystemtypebtrfs-properties-btrfs.md)) diff --git a/docs/user/unattended/reference/storage-defs-boot-properties-configure.md b/docs/user/unattended/reference/storage-defs-boot-properties-configure.md new file mode 100644 index 0000000..b46067a --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-boot-properties-configure.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/configure +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## configure Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-boot.md b/docs/user/unattended/reference/storage-defs-boot.md new file mode 100644 index 0000000..cdc9be9 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-boot.md @@ -0,0 +1,58 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## boot Type + +`object` ([Details](storage-defs-boot.md)) + +# boot Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [configure](#configure) | `boolean` | Required | cannot be null | [Config](storage-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/configure") | +| [device](#device) | `object` | Optional | cannot be null | [Config](storage-defs-bootdevice.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/device") | + +## configure + + + +`configure` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/configure") + +### configure Type + +`boolean` + +## device + + + +`device` + +* is optional + +* Type: `object` ([Details](storage-defs-bootdevice.md)) + +* cannot be null + +* defined in: [Config](storage-defs-bootdevice.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/device") + +### device Type + +`object` ([Details](storage-defs-bootdevice.md)) diff --git a/docs/user/unattended/reference/storage-defs-bootdevice-properties-default.md b/docs/user/unattended/reference/storage-defs-bootdevice-properties-default.md new file mode 100644 index 0000000..0950332 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-bootdevice-properties-default.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/default +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## default Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-bootdevice-properties-name.md b/docs/user/unattended/reference/storage-defs-bootdevice-properties-name.md new file mode 100644 index 0000000..f3f47e2 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-bootdevice-properties-name.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/name +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## name Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-bootdevice.md b/docs/user/unattended/reference/storage-defs-bootdevice.md new file mode 100644 index 0000000..2f5b1f8 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-bootdevice.md @@ -0,0 +1,58 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## bootDevice Type + +`object` ([Details](storage-defs-bootdevice.md)) + +# bootDevice Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [default](#default) | `boolean` | Required | cannot be null | [Config](storage-defs-bootdevice-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/default") | +| [name](#name) | `string` | Optional | cannot be null | [Config](storage-defs-bootdevice-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/name") | + +## default + + + +`default` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-bootdevice-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/default") + +### default Type + +`boolean` + +## name + + + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-bootdevice-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/name") + +### name Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-drive-properties-mountpath.md b/docs/user/unattended/reference/storage-defs-drive-properties-mountpath.md new file mode 100644 index 0000000..3a76a98 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-drive-properties-mountpath.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/mountPath +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## mountPath Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-drive-properties-name.md b/docs/user/unattended/reference/storage-defs-drive-properties-name.md new file mode 100644 index 0000000..0275d3c --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-drive-properties-name.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/name +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## name Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-drive-properties-partitions.md b/docs/user/unattended/reference/storage-defs-drive-properties-partitions.md new file mode 100644 index 0000000..06c764d --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-drive-properties-partitions.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/partitions +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## partitions Type + +`object[]` ([Details](storage-defs-partition.md)) diff --git a/docs/user/unattended/reference/storage-defs-drive-properties-ptabletype.md b/docs/user/unattended/reference/storage-defs-drive-properties-ptabletype.md new file mode 100644 index 0000000..8b58742 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-drive-properties-ptabletype.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/ptableType +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## ptableType Type + +unknown + +## ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | diff --git a/docs/user/unattended/reference/storage-defs-drive-properties-spacepolicy.md b/docs/user/unattended/reference/storage-defs-drive-properties-spacepolicy.md new file mode 100644 index 0000000..dd1fc28 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-drive-properties-spacepolicy.md @@ -0,0 +1,26 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/spacePolicy +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## spacePolicy Type + +unknown + +## spacePolicy Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"delete"` | | +| `"resize"` | | +| `"keep"` | | +| `"custom"` | | diff --git a/docs/user/unattended/reference/storage-defs-drive.md b/docs/user/unattended/reference/storage-defs-drive.md new file mode 100644 index 0000000..6491186 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-drive.md @@ -0,0 +1,155 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## drive Type + +`object` ([Details](storage-defs-drive.md)) + +# drive Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name) | `string` | Required | cannot be null | [Config](storage-defs-drive-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/name") | +| [mountPath](#mountpath) | `string` | Optional | cannot be null | [Config](storage-defs-drive-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/mountPath") | +| [filesystem](#filesystem) | `object` | Optional | cannot be null | [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/filesystem") | +| [spacePolicy](#spacepolicy) | Not specified | Optional | cannot be null | [Config](storage-defs-drive-properties-spacepolicy.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/spacePolicy") | +| [ptableType](#ptabletype) | Not specified | Optional | cannot be null | [Config](storage-defs-drive-properties-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/ptableType") | +| [partitions](#partitions) | `array` | Optional | cannot be null | [Config](storage-defs-drive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/partitions") | + +## name + + + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/name") + +### name Type + +`string` + +## mountPath + + + +`mountPath` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/mountPath") + +### mountPath Type + +`string` + +## filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/filesystem") + +### filesystem Type + +`object` ([Details](storage-defs-filesystem.md)) + +## spacePolicy + + + +`spacePolicy` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-spacepolicy.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/spacePolicy") + +### spacePolicy Type + +unknown + +### spacePolicy Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"delete"` | | +| `"resize"` | | +| `"keep"` | | +| `"custom"` | | + +## ptableType + + + +`ptableType` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/ptableType") + +### ptableType Type + +unknown + +### ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | + +## partitions + + + +`partitions` + +* is optional + +* Type: `object[]` ([Details](storage-defs-partition.md)) + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/partitions") + +### partitions Type + +`object[]` ([Details](storage-defs-partition.md)) diff --git a/docs/user/unattended/reference/storage-defs-encryption-properties-method.md b/docs/user/unattended/reference/storage-defs-encryption-properties-method.md new file mode 100644 index 0000000..42ab3b7 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-encryption-properties-method.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/method +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## method Type + +unknown + +## method Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"luks1"` | | +| `"luks2"` | | +| `"tpmFde"` | | diff --git a/docs/user/unattended/reference/storage-defs-encryption-properties-password.md b/docs/user/unattended/reference/storage-defs-encryption-properties-password.md new file mode 100644 index 0000000..06e3df0 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-encryption-properties-password.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/password +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## password Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-encryption.md b/docs/user/unattended/reference/storage-defs-encryption.md new file mode 100644 index 0000000..f361f0a --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-encryption.md @@ -0,0 +1,68 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## encryption Type + +`object` ([Details](storage-defs-encryption.md)) + +# encryption Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [method](#method) | Not specified | Required | cannot be null | [Config](storage-defs-encryption-properties-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/method") | +| [password](#password) | `string` | Optional | cannot be null | [Config](storage-defs-encryption-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/password") | + +## method + + + +`method` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-encryption-properties-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/method") + +### method Type + +unknown + +### method Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"luks1"` | | +| `"luks2"` | | +| `"tpmFde"` | | + +## password + + + +`password` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-encryption-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/password") + +### password Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-encryptionmethod.md b/docs/user/unattended/reference/storage-defs-encryptionmethod.md new file mode 100644 index 0000000..b772be2 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-encryptionmethod.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryptionMethod +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## encryptionMethod Type + +unknown + +## encryptionMethod Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"luks1"` | | +| `"luks2"` | | +| `"tpmFde"` | | diff --git a/docs/user/unattended/reference/storage-defs-filesystem-properties-default.md b/docs/user/unattended/reference/storage-defs-filesystem-properties-default.md new file mode 100644 index 0000000..9e3c3ce --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-filesystem-properties-default.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/default +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## default Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-filesystem-properties-label.md b/docs/user/unattended/reference/storage-defs-filesystem-properties-label.md new file mode 100644 index 0000000..032175d --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-filesystem-properties-label.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/label +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## label Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-filesystem-properties-reuse.md b/docs/user/unattended/reference/storage-defs-filesystem-properties-reuse.md new file mode 100644 index 0000000..9fbb467 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-filesystem-properties-reuse.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/reuse +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## reuse Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-filesystem-properties-snapshots.md b/docs/user/unattended/reference/storage-defs-filesystem-properties-snapshots.md new file mode 100644 index 0000000..7c64364 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-filesystem-properties-snapshots.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/snapshots +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## snapshots Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-filesystem-properties-type.md b/docs/user/unattended/reference/storage-defs-filesystem-properties-type.md new file mode 100644 index 0000000..e35dd18 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-filesystem-properties-type.md @@ -0,0 +1,38 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/type +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## type Type + +unknown + +## type Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"bcachefs"` | | +| `"btrfs"` | | +| `"exfat"` | | +| `"ext2"` | | +| `"ext3"` | | +| `"ext4"` | | +| `"f2fs"` | | +| `"jfs"` | | +| `"nfs"` | | +| `"nilfs2"` | | +| `"ntfs"` | | +| `"reiserfs"` | | +| `"swap"` | | +| `"tmpfs"` | | +| `"vfat"` | | +| `"xfs"` | | diff --git a/docs/user/unattended/reference/storage-defs-filesystem.md b/docs/user/unattended/reference/storage-defs-filesystem.md new file mode 100644 index 0000000..226cc4b --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-filesystem.md @@ -0,0 +1,138 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## filesystem Type + +`object` ([Details](storage-defs-filesystem.md)) + +# filesystem Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [reuse](#reuse) | `boolean` | Optional | cannot be null | [Config](storage-defs-filesystem-properties-reuse.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/reuse") | +| [default](#default) | `boolean` | Required | cannot be null | [Config](storage-defs-filesystem-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/default") | +| [type](#type) | Not specified | Optional | cannot be null | [Config](storage-defs-filesystem-properties-type.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/type") | +| [snapshots](#snapshots) | `boolean` | Optional | cannot be null | [Config](storage-defs-filesystem-properties-snapshots.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/snapshots") | +| [label](#label) | `string` | Optional | cannot be null | [Config](storage-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/label") | + +## reuse + + + +`reuse` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-reuse.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/reuse") + +### reuse Type + +`boolean` + +## default + + + +`default` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/default") + +### default Type + +`boolean` + +## type + + + +`type` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-type.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/type") + +### type Type + +unknown + +### type Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"bcachefs"` | | +| `"btrfs"` | | +| `"exfat"` | | +| `"ext2"` | | +| `"ext3"` | | +| `"ext4"` | | +| `"f2fs"` | | +| `"jfs"` | | +| `"nfs"` | | +| `"nilfs2"` | | +| `"ntfs"` | | +| `"reiserfs"` | | +| `"swap"` | | +| `"tmpfs"` | | +| `"vfat"` | | +| `"xfs"` | | + +## snapshots + + + +`snapshots` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-snapshots.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/snapshots") + +### snapshots Type + +`boolean` + +## label + + + +`label` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/label") + +### label Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-filesystemtype.md b/docs/user/unattended/reference/storage-defs-filesystemtype.md new file mode 100644 index 0000000..4daba5a --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-filesystemtype.md @@ -0,0 +1,38 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystemType +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## filesystemType Type + +unknown + +## filesystemType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"bcachefs"` | | +| `"btrfs"` | | +| `"exfat"` | | +| `"ext2"` | | +| `"ext3"` | | +| `"ext4"` | | +| `"f2fs"` | | +| `"jfs"` | | +| `"nfs"` | | +| `"nilfs2"` | | +| `"ntfs"` | | +| `"reiserfs"` | | +| `"swap"` | | +| `"tmpfs"` | | +| `"vfat"` | | +| `"xfs"` | | diff --git a/docs/user/unattended/reference/storage-defs-logicalvolume-properties-lvname.md b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-lvname.md new file mode 100644 index 0000000..14ace24 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-lvname.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/lvName +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## lvName Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-logicalvolume-properties-mountpath.md b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-mountpath.md new file mode 100644 index 0000000..e4a9dea --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-mountpath.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/mountPath +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## mountPath Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-logicalvolume-properties-stripes.md b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-stripes.md new file mode 100644 index 0000000..2acc83b --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-stripes.md @@ -0,0 +1,15 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripes +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## stripes Type + +`integer` diff --git a/docs/user/unattended/reference/storage-defs-logicalvolume-properties-stripesize.md b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-stripesize.md new file mode 100644 index 0000000..3190e9a --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-logicalvolume-properties-stripesize.md @@ -0,0 +1,15 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripeSize +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## stripeSize Type + +`integer` diff --git a/docs/user/unattended/reference/storage-defs-logicalvolume.md b/docs/user/unattended/reference/storage-defs-logicalvolume.md new file mode 100644 index 0000000..20a8b5b --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-logicalvolume.md @@ -0,0 +1,134 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## logicalVolume Type + +`object` ([Details](storage-defs-logicalvolume.md)) + +# logicalVolume Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [lvName](#lvname) | `string` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-lvname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/lvName") | +| [mountPath](#mountpath) | `string` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/mountPath") | +| [filesystem](#filesystem) | `object` | Optional | cannot be null | [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/filesystem") | +| [size](#size) | `object` | Optional | cannot be null | [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/size") | +| [stripes](#stripes) | `integer` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripes") | +| [stripeSize](#stripesize) | `integer` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-stripesize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripeSize") | + +## lvName + + + +`lvName` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-lvname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/lvName") + +### lvName Type + +`string` + +## mountPath + + + +`mountPath` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/mountPath") + +### mountPath Type + +`string` + +## filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/filesystem") + +### filesystem Type + +`object` ([Details](storage-defs-filesystem.md)) + +## size + + + +`size` + +* is optional + +* Type: `object` ([Details](storage-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/size") + +### size Type + +`object` ([Details](storage-defs-size.md)) + +## stripes + + + +`stripes` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripes") + +### stripes Type + +`integer` + +## stripeSize + + + +`stripeSize` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-stripesize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripeSize") + +### stripeSize Type + +`integer` diff --git a/docs/user/unattended/reference/storage-defs-partition-properties-delete.md b/docs/user/unattended/reference/storage-defs-partition-properties-delete.md new file mode 100644 index 0000000..75bf17a --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition-properties-delete.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/delete +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## delete Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-partition-properties-deleteifneeded.md b/docs/user/unattended/reference/storage-defs-partition-properties-deleteifneeded.md new file mode 100644 index 0000000..3cce0fd --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition-properties-deleteifneeded.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/deleteIfNeeded +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## deleteIfNeeded Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-partition-properties-id.md b/docs/user/unattended/reference/storage-defs-partition-properties-id.md new file mode 100644 index 0000000..047a002 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition-properties-id.md @@ -0,0 +1,29 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/id +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## id Type + +unknown + +## id Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"linux"` | | +| `"swap"` | | +| `"lvm"` | | +| `"raid"` | | +| `"esp"` | | +| `"prep"` | | +| `"bios_boot"` | | diff --git a/docs/user/unattended/reference/storage-defs-partition-properties-mountpath.md b/docs/user/unattended/reference/storage-defs-partition-properties-mountpath.md new file mode 100644 index 0000000..c7fd402 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition-properties-mountpath.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/mountPath +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## mountPath Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-partition-properties-name.md b/docs/user/unattended/reference/storage-defs-partition-properties-name.md new file mode 100644 index 0000000..feb6a96 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition-properties-name.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/name +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## name Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-partition-properties-resize.md b/docs/user/unattended/reference/storage-defs-partition-properties-resize.md new file mode 100644 index 0000000..75b8d82 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition-properties-resize.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resize +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## resize Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-partition-properties-resizeifneeded.md b/docs/user/unattended/reference/storage-defs-partition-properties-resizeifneeded.md new file mode 100644 index 0000000..2a05280 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition-properties-resizeifneeded.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resizeIfNeeded +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## resizeIfNeeded Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-partition.md b/docs/user/unattended/reference/storage-defs-partition.md new file mode 100644 index 0000000..d6af567 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partition.md @@ -0,0 +1,205 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## partition Type + +`object` ([Details](storage-defs-partition.md)) + +# partition Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [name](#name) | `string` | Optional | cannot be null | [Config](storage-defs-partition-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/name") | +| [id](#id) | Not specified | Optional | cannot be null | [Config](storage-defs-partition-properties-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/id") | +| [mountPath](#mountpath) | `string` | Optional | cannot be null | [Config](storage-defs-partition-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/mountPath") | +| [filesystem](#filesystem) | `object` | Optional | cannot be null | [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/filesystem") | +| [size](#size) | `object` | Optional | cannot be null | [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/size") | +| [delete](#delete) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/delete") | +| [deleteIfNeeded](#deleteifneeded) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/deleteIfNeeded") | +| [resize](#resize) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-resize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resize") | +| [resizeIfNeeded](#resizeifneeded) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-resizeifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resizeIfNeeded") | + +## name + + + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/name") + +### name Type + +`string` + +## id + + + +`id` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/id") + +### id Type + +unknown + +### id Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"linux"` | | +| `"swap"` | | +| `"lvm"` | | +| `"raid"` | | +| `"esp"` | | +| `"prep"` | | +| `"bios_boot"` | | + +## mountPath + + + +`mountPath` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/mountPath") + +### mountPath Type + +`string` + +## filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/filesystem") + +### filesystem Type + +`object` ([Details](storage-defs-filesystem.md)) + +## size + + + +`size` + +* is optional + +* Type: `object` ([Details](storage-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/size") + +### size Type + +`object` ([Details](storage-defs-size.md)) + +## delete + + + +`delete` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/delete") + +### delete Type + +`boolean` + +## deleteIfNeeded + + + +`deleteIfNeeded` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/deleteIfNeeded") + +### deleteIfNeeded Type + +`boolean` + +## resize + + + +`resize` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-resize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resize") + +### resize Type + +`boolean` + +## resizeIfNeeded + + + +`resizeIfNeeded` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-resizeifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resizeIfNeeded") + +### resizeIfNeeded Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-partitionid.md b/docs/user/unattended/reference/storage-defs-partitionid.md new file mode 100644 index 0000000..fbe9862 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-partitionid.md @@ -0,0 +1,29 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partitionId +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## partitionId Type + +unknown + +## partitionId Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"linux"` | | +| `"swap"` | | +| `"lvm"` | | +| `"raid"` | | +| `"esp"` | | +| `"prep"` | | +| `"bios_boot"` | | diff --git a/docs/user/unattended/reference/storage-defs-ptabletype.md b/docs/user/unattended/reference/storage-defs-ptabletype.md new file mode 100644 index 0000000..7d4b011 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-ptabletype.md @@ -0,0 +1,25 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/ptableType +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## ptableType Type + +unknown + +## ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | diff --git a/docs/user/unattended/reference/storage-defs-size-properties-default.md b/docs/user/unattended/reference/storage-defs-size-properties-default.md new file mode 100644 index 0000000..d739280 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-size-properties-default.md @@ -0,0 +1,15 @@ +# Untitled boolean in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/default +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## default Type + +`boolean` diff --git a/docs/user/unattended/reference/storage-defs-size-properties-max.md b/docs/user/unattended/reference/storage-defs-size-properties-max.md new file mode 100644 index 0000000..7439d27 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-size-properties-max.md @@ -0,0 +1,19 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/max +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## max Type + +`integer` + +## max Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/storage-defs-size-properties-min.md b/docs/user/unattended/reference/storage-defs-size-properties-min.md new file mode 100644 index 0000000..98f75b3 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-size-properties-min.md @@ -0,0 +1,19 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/min +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## min Type + +`integer` + +## min Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/storage-defs-size.md b/docs/user/unattended/reference/storage-defs-size.md new file mode 100644 index 0000000..d595180 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-size.md @@ -0,0 +1,85 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## size Type + +`object` ([Details](storage-defs-size.md)) + +# size Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [default](#default) | `boolean` | Required | cannot be null | [Config](storage-defs-size-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/default") | +| [min](#min) | `integer` | Required | cannot be null | [Config](storage-defs-size-properties-min.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/min") | +| [max](#max) | `integer` | Optional | cannot be null | [Config](storage-defs-size-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/max") | + +## default + + + +`default` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-size-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/default") + +### default Type + +`boolean` + +## min + + + +`min` + +* is required + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-size-properties-min.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/min") + +### min Type + +`integer` + +### min Constraints + +**minimum**: the value of this number must greater than or equal to: `0` + +## max + + + +`max` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-size-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/max") + +### max Type + +`integer` + +### max Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/storage-defs-spacepolicy.md b/docs/user/unattended/reference/storage-defs-spacepolicy.md new file mode 100644 index 0000000..92ee569 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-spacepolicy.md @@ -0,0 +1,26 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/spacePolicy +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## spacePolicy Type + +unknown + +## spacePolicy Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"delete"` | | +| `"resize"` | | +| `"keep"` | | +| `"custom"` | | diff --git a/docs/user/unattended/reference/storage-defs-volumegroup-properties-extentsize.md b/docs/user/unattended/reference/storage-defs-volumegroup-properties-extentsize.md new file mode 100644 index 0000000..34413c4 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-volumegroup-properties-extentsize.md @@ -0,0 +1,15 @@ +# Untitled integer in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/extentSize +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## extentSize Type + +`integer` diff --git a/docs/user/unattended/reference/storage-defs-volumegroup-properties-logicalvolumes.md b/docs/user/unattended/reference/storage-defs-volumegroup-properties-logicalvolumes.md new file mode 100644 index 0000000..116da25 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-volumegroup-properties-logicalvolumes.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/logicalVolumes +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## logicalVolumes Type + +`object[]` ([Details](storage-defs-logicalvolume.md)) diff --git a/docs/user/unattended/reference/storage-defs-volumegroup-properties-targetdevices-items.md b/docs/user/unattended/reference/storage-defs-volumegroup-properties-targetdevices-items.md new file mode 100644 index 0000000..47b1845 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-volumegroup-properties-targetdevices-items.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/targetDevices/items +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## items Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-volumegroup-properties-targetdevices.md b/docs/user/unattended/reference/storage-defs-volumegroup-properties-targetdevices.md new file mode 100644 index 0000000..84d5eb5 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-volumegroup-properties-targetdevices.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/targetDevices +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## targetDevices Type + +`string[]` diff --git a/docs/user/unattended/reference/storage-defs-volumegroup-properties-vgname.md b/docs/user/unattended/reference/storage-defs-volumegroup-properties-vgname.md new file mode 100644 index 0000000..cff75c1 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-volumegroup-properties-vgname.md @@ -0,0 +1,15 @@ +# Untitled string in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/vgName +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## vgName Type + +`string` diff --git a/docs/user/unattended/reference/storage-defs-volumegroup.md b/docs/user/unattended/reference/storage-defs-volumegroup.md new file mode 100644 index 0000000..a12c433 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs-volumegroup.md @@ -0,0 +1,96 @@ +# Untitled object in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## volumeGroup Type + +`object` ([Details](storage-defs-volumegroup.md)) + +# volumeGroup Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [vgName](#vgname) | `string` | Required | cannot be null | [Config](storage-defs-volumegroup-properties-vgname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/vgName") | +| [extentSize](#extentsize) | `integer` | Optional | cannot be null | [Config](storage-defs-volumegroup-properties-extentsize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/extentSize") | +| [targetDevices](#targetdevices) | `array` | Optional | cannot be null | [Config](storage-defs-volumegroup-properties-targetdevices.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/targetDevices") | +| [logicalVolumes](#logicalvolumes) | `array` | Optional | cannot be null | [Config](storage-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/logicalVolumes") | + +## vgName + + + +`vgName` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-vgname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/vgName") + +### vgName Type + +`string` + +## extentSize + + + +`extentSize` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-extentsize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/extentSize") + +### extentSize Type + +`integer` + +## targetDevices + + + +`targetDevices` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-targetdevices.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/targetDevices") + +### targetDevices Type + +`string[]` + +## logicalVolumes + + + +`logicalVolumes` + +* is optional + +* Type: `object[]` ([Details](storage-defs-logicalvolume.md)) + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/logicalVolumes") + +### logicalVolumes Type + +`object[]` ([Details](storage-defs-logicalvolume.md)) diff --git a/docs/user/unattended/reference/storage-defs.md b/docs/user/unattended/reference/storage-defs.md new file mode 100644 index 0000000..a08deb8 --- /dev/null +++ b/docs/user/unattended/reference/storage-defs.md @@ -0,0 +1,15 @@ +# Untitled undefined type in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## $defs Type + +unknown diff --git a/docs/user/unattended/reference/storage-properties-drives.md b/docs/user/unattended/reference/storage-properties-drives.md new file mode 100644 index 0000000..b8fab14 --- /dev/null +++ b/docs/user/unattended/reference/storage-properties-drives.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/drives +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## drives Type + +`object[]` ([Details](storage-defs-drive.md)) diff --git a/docs/user/unattended/reference/storage-properties-volumegroups.md b/docs/user/unattended/reference/storage-properties-volumegroups.md new file mode 100644 index 0000000..061466e --- /dev/null +++ b/docs/user/unattended/reference/storage-properties-volumegroups.md @@ -0,0 +1,15 @@ +# Untitled array in Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/volumeGroups +``` + + + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [storage.model.schema.json\*](storage.model.schema.json "open original schema") | + +## volumeGroups Type + +`object[]` ([Details](storage-defs-volumegroup.md)) diff --git a/docs/user/unattended/reference/storage.md b/docs/user/unattended/reference/storage.md new file mode 100644 index 0000000..333ab9f --- /dev/null +++ b/docs/user/unattended/reference/storage.md @@ -0,0 +1,1069 @@ +# Config Schema + +```txt +https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json +``` + +Config model + +| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | +| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------- | +| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [storage.model.schema.json](storage.model.schema.json "open original schema") | + +## Config Type + +`object` ([Config](storage.md)) + +# Config Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [boot](#boot) | `object` | Optional | cannot be null | [Config](storage-defs-boot.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/boot") | +| [encryption](#encryption) | `object` | Optional | cannot be null | [Config](storage-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/encryption") | +| [drives](#drives) | `array` | Optional | cannot be null | [Config](storage-properties-drives.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/drives") | +| [volumeGroups](#volumegroups) | `array` | Optional | cannot be null | [Config](storage-properties-volumegroups.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/volumeGroups") | + +## boot + + + +`boot` + +* is optional + +* Type: `object` ([Details](storage-defs-boot.md)) + +* cannot be null + +* defined in: [Config](storage-defs-boot.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/boot") + +### boot Type + +`object` ([Details](storage-defs-boot.md)) + +## encryption + + + +`encryption` + +* is optional + +* Type: `object` ([Details](storage-defs-encryption.md)) + +* cannot be null + +* defined in: [Config](storage-defs-encryption.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/encryption") + +### encryption Type + +`object` ([Details](storage-defs-encryption.md)) + +## drives + + + +`drives` + +* is optional + +* Type: `object[]` ([Details](storage-defs-drive.md)) + +* cannot be null + +* defined in: [Config](storage-properties-drives.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/drives") + +### drives Type + +`object[]` ([Details](storage-defs-drive.md)) + +## volumeGroups + + + +`volumeGroups` + +* is optional + +* Type: `object[]` ([Details](storage-defs-volumegroup.md)) + +* cannot be null + +* defined in: [Config](storage-properties-volumegroups.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/properties/volumeGroups") + +### volumeGroups Type + +`object[]` ([Details](storage-defs-volumegroup.md)) + +# Config Definitions + +## Definitions group boot + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [configure](#configure) | `boolean` | Required | cannot be null | [Config](storage-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/configure") | +| [device](#device) | `object` | Optional | cannot be null | [Config](storage-defs-bootdevice.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/device") | + +### configure + + + +`configure` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-boot-properties-configure.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/configure") + +#### configure Type + +`boolean` + +### device + + + +`device` + +* is optional + +* Type: `object` ([Details](storage-defs-bootdevice.md)) + +* cannot be null + +* defined in: [Config](storage-defs-bootdevice.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/boot/properties/device") + +#### device Type + +`object` ([Details](storage-defs-bootdevice.md)) + +## Definitions group bootDevice + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [default](#default) | `boolean` | Required | cannot be null | [Config](storage-defs-bootdevice-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/default") | +| [name](#name) | `string` | Optional | cannot be null | [Config](storage-defs-bootdevice-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/name") | + +### default + + + +`default` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-bootdevice-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/default") + +#### default Type + +`boolean` + +### name + + + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-bootdevice-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/bootDevice/properties/name") + +#### name Type + +`string` + +## Definitions group encryption + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [method](#method) | Not specified | Required | cannot be null | [Config](storage-defs-encryption-properties-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/method") | +| [password](#password) | `string` | Optional | cannot be null | [Config](storage-defs-encryption-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/password") | + +### method + + + +`method` + +* is required + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-encryption-properties-method.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/method") + +#### method Type + +unknown + +#### method Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"luks1"` | | +| `"luks2"` | | +| `"tpmFde"` | | + +### password + + + +`password` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-encryption-properties-password.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryption/properties/password") + +#### password Type + +`string` + +## Definitions group encryptionMethod + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/encryptionMethod"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group drive + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [name](#name-1) | `string` | Required | cannot be null | [Config](storage-defs-drive-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/name") | +| [mountPath](#mountpath) | `string` | Optional | cannot be null | [Config](storage-defs-drive-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/mountPath") | +| [filesystem](#filesystem) | `object` | Optional | cannot be null | [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/filesystem") | +| [spacePolicy](#spacepolicy) | Not specified | Optional | cannot be null | [Config](storage-defs-drive-properties-spacepolicy.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/spacePolicy") | +| [ptableType](#ptabletype) | Not specified | Optional | cannot be null | [Config](storage-defs-drive-properties-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/ptableType") | +| [partitions](#partitions) | `array` | Optional | cannot be null | [Config](storage-defs-drive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/partitions") | + +### name + + + +`name` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/name") + +#### name Type + +`string` + +### mountPath + + + +`mountPath` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/mountPath") + +#### mountPath Type + +`string` + +### filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/filesystem") + +#### filesystem Type + +`object` ([Details](storage-defs-filesystem.md)) + +### spacePolicy + + + +`spacePolicy` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-spacepolicy.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/spacePolicy") + +#### spacePolicy Type + +unknown + +#### spacePolicy Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :--------- | :---------- | +| `"delete"` | | +| `"resize"` | | +| `"keep"` | | +| `"custom"` | | + +### ptableType + + + +`ptableType` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-ptabletype.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/ptableType") + +#### ptableType Type + +unknown + +#### ptableType Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :-------- | :---------- | +| `"gpt"` | | +| `"msdos"` | | +| `"dasd"` | | + +### partitions + + + +`partitions` + +* is optional + +* Type: `object[]` ([Details](storage-defs-partition.md)) + +* cannot be null + +* defined in: [Config](storage-defs-drive-properties-partitions.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/drive/properties/partitions") + +#### partitions Type + +`object[]` ([Details](storage-defs-partition.md)) + +## Definitions group partition + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [name](#name-2) | `string` | Optional | cannot be null | [Config](storage-defs-partition-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/name") | +| [id](#id) | Not specified | Optional | cannot be null | [Config](storage-defs-partition-properties-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/id") | +| [mountPath](#mountpath-1) | `string` | Optional | cannot be null | [Config](storage-defs-partition-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/mountPath") | +| [filesystem](#filesystem-1) | `object` | Optional | cannot be null | [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/filesystem") | +| [size](#size) | `object` | Optional | cannot be null | [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/size") | +| [delete](#delete) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/delete") | +| [deleteIfNeeded](#deleteifneeded) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/deleteIfNeeded") | +| [resize](#resize) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-resize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resize") | +| [resizeIfNeeded](#resizeifneeded) | `boolean` | Optional | cannot be null | [Config](storage-defs-partition-properties-resizeifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resizeIfNeeded") | + +### name + + + +`name` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-name.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/name") + +#### name Type + +`string` + +### id + + + +`id` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-id.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/id") + +#### id Type + +unknown + +#### id Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :------------ | :---------- | +| `"linux"` | | +| `"swap"` | | +| `"lvm"` | | +| `"raid"` | | +| `"esp"` | | +| `"prep"` | | +| `"bios_boot"` | | + +### mountPath + + + +`mountPath` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/mountPath") + +#### mountPath Type + +`string` + +### filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/filesystem") + +#### filesystem Type + +`object` ([Details](storage-defs-filesystem.md)) + +### size + + + +`size` + +* is optional + +* Type: `object` ([Details](storage-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/size") + +#### size Type + +`object` ([Details](storage-defs-size.md)) + +### delete + + + +`delete` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-delete.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/delete") + +#### delete Type + +`boolean` + +### deleteIfNeeded + + + +`deleteIfNeeded` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-deleteifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/deleteIfNeeded") + +#### deleteIfNeeded Type + +`boolean` + +### resize + + + +`resize` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-resize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resize") + +#### resize Type + +`boolean` + +### resizeIfNeeded + + + +`resizeIfNeeded` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-partition-properties-resizeifneeded.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partition/properties/resizeIfNeeded") + +#### resizeIfNeeded Type + +`boolean` + +## Definitions group volumeGroup + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [vgName](#vgname) | `string` | Required | cannot be null | [Config](storage-defs-volumegroup-properties-vgname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/vgName") | +| [extentSize](#extentsize) | `integer` | Optional | cannot be null | [Config](storage-defs-volumegroup-properties-extentsize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/extentSize") | +| [targetDevices](#targetdevices) | `array` | Optional | cannot be null | [Config](storage-defs-volumegroup-properties-targetdevices.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/targetDevices") | +| [logicalVolumes](#logicalvolumes) | `array` | Optional | cannot be null | [Config](storage-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/logicalVolumes") | + +### vgName + + + +`vgName` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-vgname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/vgName") + +#### vgName Type + +`string` + +### extentSize + + + +`extentSize` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-extentsize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/extentSize") + +#### extentSize Type + +`integer` + +### targetDevices + + + +`targetDevices` + +* is optional + +* Type: `string[]` + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-targetdevices.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/targetDevices") + +#### targetDevices Type + +`string[]` + +### logicalVolumes + + + +`logicalVolumes` + +* is optional + +* Type: `object[]` ([Details](storage-defs-logicalvolume.md)) + +* cannot be null + +* defined in: [Config](storage-defs-volumegroup-properties-logicalvolumes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/volumeGroup/properties/logicalVolumes") + +#### logicalVolumes Type + +`object[]` ([Details](storage-defs-logicalvolume.md)) + +## Definitions group logicalVolume + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [lvName](#lvname) | `string` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-lvname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/lvName") | +| [mountPath](#mountpath-2) | `string` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/mountPath") | +| [filesystem](#filesystem-2) | `object` | Optional | cannot be null | [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/filesystem") | +| [size](#size-1) | `object` | Optional | cannot be null | [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/size") | +| [stripes](#stripes) | `integer` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripes") | +| [stripeSize](#stripesize) | `integer` | Optional | cannot be null | [Config](storage-defs-logicalvolume-properties-stripesize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripeSize") | + +### lvName + + + +`lvName` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-lvname.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/lvName") + +#### lvName Type + +`string` + +### mountPath + + + +`mountPath` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-mountpath.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/mountPath") + +#### mountPath Type + +`string` + +### filesystem + + + +`filesystem` + +* is optional + +* Type: `object` ([Details](storage-defs-filesystem.md)) + +* cannot be null + +* defined in: [Config](storage-defs-filesystem.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/filesystem") + +#### filesystem Type + +`object` ([Details](storage-defs-filesystem.md)) + +### size + + + +`size` + +* is optional + +* Type: `object` ([Details](storage-defs-size.md)) + +* cannot be null + +* defined in: [Config](storage-defs-size.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/size") + +#### size Type + +`object` ([Details](storage-defs-size.md)) + +### stripes + + + +`stripes` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-stripes.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripes") + +#### stripes Type + +`integer` + +### stripeSize + + + +`stripeSize` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-logicalvolume-properties-stripesize.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/logicalVolume/properties/stripeSize") + +#### stripeSize Type + +`integer` + +## Definitions group spacePolicy + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/spacePolicy"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group ptableType + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/ptableType"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group partitionId + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/partitionId"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group filesystem + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [reuse](#reuse) | `boolean` | Optional | cannot be null | [Config](storage-defs-filesystem-properties-reuse.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/reuse") | +| [default](#default-1) | `boolean` | Required | cannot be null | [Config](storage-defs-filesystem-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/default") | +| [type](#type) | Not specified | Optional | cannot be null | [Config](storage-defs-filesystem-properties-type.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/type") | +| [snapshots](#snapshots) | `boolean` | Optional | cannot be null | [Config](storage-defs-filesystem-properties-snapshots.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/snapshots") | +| [label](#label) | `string` | Optional | cannot be null | [Config](storage-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/label") | + +### reuse + + + +`reuse` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-reuse.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/reuse") + +#### reuse Type + +`boolean` + +### default + + + +`default` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/default") + +#### default Type + +`boolean` + +### type + + + +`type` + +* is optional + +* Type: unknown + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-type.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/type") + +#### type Type + +unknown + +#### type Constraints + +**enum**: the value of this property must be equal to one of the following values: + +| Value | Explanation | +| :----------- | :---------- | +| `"bcachefs"` | | +| `"btrfs"` | | +| `"exfat"` | | +| `"ext2"` | | +| `"ext3"` | | +| `"ext4"` | | +| `"f2fs"` | | +| `"jfs"` | | +| `"nfs"` | | +| `"nilfs2"` | | +| `"ntfs"` | | +| `"reiserfs"` | | +| `"swap"` | | +| `"tmpfs"` | | +| `"vfat"` | | +| `"xfs"` | | + +### snapshots + + + +`snapshots` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-snapshots.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/snapshots") + +#### snapshots Type + +`boolean` + +### label + + + +`label` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Config](storage-defs-filesystem-properties-label.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystem/properties/label") + +#### label Type + +`string` + +## Definitions group filesystemType + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/filesystemType"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :------- | :--- | :------- | :------- | :--------- | + +## Definitions group size + +Reference this group by using + +```json +{"$ref":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size"} +``` + +| Property | Type | Required | Nullable | Defined by | +| :-------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [default](#default-2) | `boolean` | Required | cannot be null | [Config](storage-defs-size-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/default") | +| [min](#min) | `integer` | Required | cannot be null | [Config](storage-defs-size-properties-min.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/min") | +| [max](#max) | `integer` | Optional | cannot be null | [Config](storage-defs-size-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/max") | + +### default + + + +`default` + +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Config](storage-defs-size-properties-default.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/default") + +#### default Type + +`boolean` + +### min + + + +`min` + +* is required + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-size-properties-min.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/min") + +#### min Type + +`integer` + +#### min Constraints + +**minimum**: the value of this number must greater than or equal to: `0` + +### max + + + +`max` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Config](storage-defs-size-properties-max.md "https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json#/$defs/size/properties/max") + +#### max Type + +`integer` + +#### max Constraints + +**minimum**: the value of this number must greater than or equal to: `0` diff --git a/docs/user/unattended/reference/storage.model.schema.json b/docs/user/unattended/reference/storage.model.schema.json new file mode 100644 index 0000000..a62e371 --- /dev/null +++ b/docs/user/unattended/reference/storage.model.schema.json @@ -0,0 +1 @@ +{"$id":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.model.schema.json","title":"Config","description":"Config model","type":"object","additionalProperties":false,"properties":{"boot":{"$ref":"#/$defs/boot"},"encryption":{"$ref":"#/$defs/encryption"},"drives":{"type":"array","items":{"$ref":"#/$defs/drive"}},"volumeGroups":{"type":"array","items":{"$ref":"#/$defs/volumeGroup"}}},"$defs":{"boot":{"type":"object","additionalProperties":false,"required":["configure"],"properties":{"configure":{"type":"boolean"},"device":{"$ref":"#/$defs/bootDevice"}}},"bootDevice":{"type":"object","additionalProperties":false,"required":["default"],"properties":{"default":{"type":"boolean"},"name":{"type":"string"}}},"encryption":{"type":"object","additionalProperties":false,"required":["method"],"properties":{"method":{"$ref":"#/$defs/encryptionMethod"},"password":{"type":"string"}}},"encryptionMethod":{"enum":["luks1","luks2","tpmFde"]},"drive":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string"},"mountPath":{"type":"string"},"filesystem":{"$ref":"#/$defs/filesystem"},"spacePolicy":{"$ref":"#/$defs/spacePolicy"},"ptableType":{"$ref":"#/$defs/ptableType"},"partitions":{"type":"array","items":{"$ref":"#/$defs/partition"}}}},"partition":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"id":{"$ref":"#/$defs/partitionId"},"mountPath":{"type":"string"},"filesystem":{"$ref":"#/$defs/filesystem"},"size":{"$ref":"#/$defs/size"},"delete":{"type":"boolean"},"deleteIfNeeded":{"type":"boolean"},"resize":{"type":"boolean"},"resizeIfNeeded":{"type":"boolean"}}},"volumeGroup":{"type":"object","additionalProperties":false,"required":["vgName"],"properties":{"vgName":{"type":"string"},"extentSize":{"type":"integer"},"targetDevices":{"type":"array","items":{"type":"string"}},"logicalVolumes":{"type":"array","items":{"$ref":"#/$defs/logicalVolume"}}}},"logicalVolume":{"type":"object","additionalProperties":false,"properties":{"lvName":{"type":"string"},"mountPath":{"type":"string"},"filesystem":{"$ref":"#/$defs/filesystem"},"size":{"$ref":"#/$defs/size"},"stripes":{"type":"integer"},"stripeSize":{"type":"integer"}}},"spacePolicy":{"enum":["delete","resize","keep","custom"]},"ptableType":{"enum":["gpt","msdos","dasd"]},"partitionId":{"enum":["linux","swap","lvm","raid","esp","prep","bios_boot"]},"filesystem":{"type":"object","additionalProperties":false,"required":["default"],"properties":{"reuse":{"type":"boolean"},"default":{"type":"boolean"},"type":{"$ref":"#/$defs/filesystemType"},"snapshots":{"type":"boolean"},"label":{"type":"string"}}},"filesystemType":{"enum":["bcachefs","btrfs","exfat","ext2","ext3","ext4","f2fs","jfs","nfs","nilfs2","ntfs","reiserfs","swap","tmpfs","vfat","xfs"]},"size":{"type":"object","additionalProperties":false,"required":["default","min"],"properties":{"default":{"type":"boolean"},"min":{"type":"integer","minimum":0},"max":{"type":"integer","minimum":0}}}}} diff --git a/docs/user/unattended/reference/storage.schema.json b/docs/user/unattended/reference/storage.schema.json new file mode 100644 index 0000000..b036f3e --- /dev/null +++ b/docs/user/unattended/reference/storage.schema.json @@ -0,0 +1 @@ +{"$comment":"Based on doc/auto_storage.md","$id":"https://github.com/openSUSE/agama/blob/master/rust/agama-lib/share/storage.schema.json","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Config","description":"Storage config.","type":"object","additionalProperties":false,"properties":{"boot":{"$ref":"#/$defs/boot"},"drives":{"description":"Drives (disks, BIOS RAIDs and multipath devices).","type":"array","items":{"$ref":"#/$defs/driveElement"}},"volumeGroups":{"description":"LVM volume groups.","type":"array","items":{"$ref":"#/$defs/volumeGroup"}}},"$defs":{"boot":{"description":"Allows configuring boot partitions automatically.","type":"object","additionalProperties":false,"required":["configure"],"properties":{"configure":{"description":"Whether to configure partitions for booting.","type":"boolean"},"device":{"$ref":"#/$defs/alias"}}},"driveElement":{"anyOf":[{"$ref":"#/$defs/formattedDrive"},{"$ref":"#/$defs/partitionedDrive"}]},"formattedDrive":{"description":"Drive without a partition table (e.g., directly formatted).","type":"object","additionalProperties":false,"required":["filesystem"],"properties":{"search":{"$ref":"#/$defs/searchElement"},"alias":{"$ref":"#/$defs/alias"},"encryption":{"$ref":"#/$defs/encryption"},"filesystem":{"$ref":"#/$defs/filesystem"}}},"partitionedDrive":{"type":"object","additionalProperties":false,"properties":{"search":{"$ref":"#/$defs/searchElement"},"alias":{"$ref":"#/$defs/alias"},"ptableType":{"$ref":"#/$defs/ptableType"},"partitions":{"type":"array","items":{"$ref":"#/$defs/partitionElement"}}}},"ptableType":{"description":"Partition table type.","$comment":"The partition table is created only if all the current partitions are deleted.","enum":["gpt","msdos","dasd"]},"partitionElement":{"anyOf":[{"$ref":"#/$defs/simpleVolumesGenerator"},{"$ref":"#/$defs/advancedPartitionsGenerator"},{"$ref":"#/$defs/regularPartition"},{"$ref":"#/$defs/partitionToDelete"},{"$ref":"#/$defs/PartitionToDeleteIfNeeded"}]},"simpleVolumesGenerator":{"description":"Automatically creates the default or mandatory volumes configured by the selected product.","type":"object","additionalProperties":false,"required":["generate"],"properties":{"generate":{"enum":["default","mandatory"]}}},"advancedPartitionsGenerator":{"description":"Creates the default or mandatory partitions configured by the selected product.","type":"object","additionalProperties":false,"required":["generate"],"properties":{"generate":{"type":"object","additionalProperties":false,"required":["partitions"],"properties":{"partitions":{"enum":["default","mandatory"]},"encryption":{"$ref":"#/$defs/encryption"}}}}},"regularPartition":{"type":"object","additionalProperties":false,"properties":{"search":{"$ref":"#/$defs/searchElement"},"alias":{"$ref":"#/$defs/alias"},"id":{"title":"Partition id","enum":["linux","swap","lvm","raid","esp","prep","bios_boot"]},"size":{"$ref":"#/$defs/size"},"encryption":{"$ref":"#/$defs/encryption"},"filesystem":{"$ref":"#/$defs/filesystem"}}},"partitionToDelete":{"type":"object","additionalProperties":false,"required":["delete","search"],"properties":{"search":{"$ref":"#/$defs/searchElement"},"delete":{"description":"Delete the partition.","const":true}}},"PartitionToDeleteIfNeeded":{"type":"object","additionalProperties":false,"required":["deleteIfNeeded","search"],"properties":{"search":{"$ref":"#/$defs/searchElement"},"deleteIfNeeded":{"description":"Delete the partition if needed to make space.","const":true},"size":{"$ref":"#/$defs/size"}}},"volumeGroup":{"description":"LVM volume group.","type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"description":"Volume group name.","type":"string","examples":["vg0"]},"extentSize":{"$ref":"#/$defs/sizeValue"},"physicalVolumes":{"description":"Devices to use as physical volumes.","type":"array","items":{"$ref":"#/$defs/physicalVolumeElement"}},"logicalVolumes":{"type":"array","items":{"$ref":"#/$defs/logicalVolumeElement"}}}},"physicalVolumeElement":{"anyOf":[{"$ref":"#/$defs/alias"},{"$ref":"#/$defs/simplePhysicalVolumesGenerator"},{"$ref":"#/$defs/advancedPhysicalVolumesGenerator"}]},"simplePhysicalVolumesGenerator":{"description":"Automatically creates the needed physical volumes in the indicated devices.","type":"object","additionalProperties":false,"required":["generate"],"properties":{"generate":{"type":"array","items":{"$ref":"#/$defs/alias"}}}},"advancedPhysicalVolumesGenerator":{"description":"Automatically creates the needed physical volumes in the indicated devices.","type":"object","additionalProperties":false,"required":["generate"],"properties":{"generate":{"type":"object","additionalProperties":false,"required":["targetDevices"],"properties":{"targetDevices":{"type":"array","items":{"$ref":"#/$defs/alias"}},"encryption":{"$ref":"#/$defs/encryption"}}}}},"logicalVolumeElement":{"anyOf":[{"$ref":"#/$defs/simpleVolumesGenerator"},{"$ref":"#/$defs/advancedLogicalVolumesGenerator"},{"$ref":"#/$defs/logicalVolume"},{"$ref":"#/$defs/thinPoolLogicalVolume"},{"$ref":"#/$defs/thinLogicalVolume"}]},"advancedLogicalVolumesGenerator":{"description":"Automatically creates the default or mandatory logical volumes configured by the selected product.","type":"object","additionalProperties":false,"required":["generate"],"properties":{"generate":{"type":"object","additionalProperties":false,"required":["logicalVolumes"],"properties":{"logicalVolumes":{"enum":["default","mandatory"]},"encryption":{"$ref":"#/$defs/encryption"},"stripes":{"$ref":"#/$defs/logicalVolumeStripes"},"stripeSize":{"$ref":"#/$defs/sizeValue"}}}}},"logicalVolume":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"Logical volume name.","type":"string","examples":["lv0"]},"size":{"$ref":"#/$defs/size"},"stripes":{"$ref":"#/$defs/logicalVolumeStripes"},"stripeSize":{"$ref":"#/$defs/sizeValue"},"encryption":{"$ref":"#/$defs/encryption"},"filesystem":{"$ref":"#/$defs/filesystem"}}},"thinPoolLogicalVolume":{"type":"object","additionalProperties":false,"required":["pool"],"properties":{"pool":{"description":"LVM thin pool.","const":true},"alias":{"$ref":"#/$defs/alias"},"name":{"description":"Logical volume name.","type":"string","examples":["lv0"]},"size":{"$ref":"#/$defs/size"},"stripes":{"$ref":"#/$defs/logicalVolumeStripes"},"stripeSize":{"$ref":"#/$defs/sizeValue"},"encryption":{"$ref":"#/$defs/encryption"}}},"thinLogicalVolume":{"type":"object","additionalProperties":false,"required":["usedPool"],"properties":{"name":{"description":"Thin logical volume name.","type":"string","examples":["lv0"]},"size":{"$ref":"#/$defs/size"},"usedPool":{"$ref":"#/$defs/alias"},"encryption":{"$ref":"#/$defs/encryption"},"filesystem":{"$ref":"#/$defs/filesystem"}}},"logicalVolumeStripes":{"description":"Number of stripes.","type":"integer","minimum":1,"maximum":128},"searchElement":{"anyOf":[{"$ref":"#/$defs/simpleSearchAll"},{"$ref":"#/$defs/simpleSearchByName"},{"$ref":"#/$defs/advancedSearch"}]},"simpleSearchAll":{"description":"Shortcut to match all devices if there is any (equivalent to specify no conditions and to skip the entry if no device is found).","const":"*"},"simpleSearchByName":{"descrition":"Search by device name","type":"string","examples":["/dev/vda","/dev/disk/by-id/ata-WDC_WD3200AAKS-75L9"]},"advancedSearch":{"description":"Advanced options for searching devices.","type":"object","additionalProperties":false,"properties":{"condition":{"title":"Search condition","type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"$ref":"#/$defs/simpleSearchByName"}}},"max":{"description":"Maximum devices to match.","type":"integer","minimum":1},"ifNotFound":{"title":"Search action","description":"How to handle the section if the device is not found.","enum":["skip","error"],"default":"error"}}},"alias":{"description":"Alias used to reference a device.","type":"string"},"size":{"title":"Size","anyOf":[{"$ref":"#/$defs/sizeValue"},{"title":"Size tuple","description":"Lower size limit and optionally upper size limit.","type":"array","items":{"$ref":"#/$defs/sizeValueWithCurrent"},"minItems":1,"maxItems":2,"examples":[[1024,"current"],["1 GiB","5 GiB"],[1024,"2 GiB"],["2 GiB"]]},{"title":"Size range","description":"Size range.","type":"object","additionalProperties":false,"required":["min"],"properties":{"min":{"$ref":"#/$defs/sizeValueWithCurrent"},"max":{"$ref":"#/$defs/sizeValueWithCurrent"}}}]},"sizeValue":{"anyOf":[{"$ref":"#/$defs/sizeString"},{"$ref":"#/$defs/sizeBytes"}]},"sizeValueWithCurrent":{"anyOf":[{"$ref":"#/$defs/sizeValue"},{"title":"Size current","description":"The current size of the device.","const":"current"}]},"sizeString":{"description":"Human readable size.","type":"string","pattern":"^[0-9]+(\\.[0-9]+)?(\\s*([KkMmGgTtPpEeZzYy][iI]?)?[Bb])?$","examples":["2 GiB","1.5 TB","1TIB","1073741824 b","1073741824"]},"sizeBytes":{"description":"Size in bytes.","type":"integer","minimum":0,"examples":[1024,2048]},"encryption":{"anyOf":[{"$ref":"#/$defs/encryptionLuks1"},{"$ref":"#/$defs/encryptionLuks2"},{"$ref":"#/$defs/encryptionPervasiveLuks2"},{"$ref":"#/$defs/encryptionTPM"},{"$ref":"#/$defs/encryptionSwap"}]},"encryptionLuks1":{"description":"LUKS1 encryption.","type":"object","additionalProperties":false,"required":["luks1"],"properties":{"luks1":{"type":"object","additionalProperties":false,"required":["password"],"properties":{"password":{"$ref":"#/$defs/encryptionPassword"},"cipher":{"$ref":"#/$defs/encryptionCipher"},"keySize":{"$ref":"#/$defs/encryptionKeySize"}}}}},"encryptionLuks2":{"description":"LUKS2 encryption.","type":"object","additionalProperties":false,"required":["luks2"],"properties":{"luks2":{"type":"object","additionalProperties":false,"required":["password"],"properties":{"password":{"$ref":"#/$defs/encryptionPassword"},"cipher":{"$ref":"#/$defs/encryptionCipher"},"keySize":{"$ref":"#/$defs/encryptionKeySize"},"pbkdFunction":{"$ref":"#/$defs/encryptionPbkdFunction"},"label":{"description":"LUKS2 label.","type":"string"}}}}},"encryptionPervasiveLuks2":{"description":"LUKS2 pervasive encryption.","type":"object","additionalProperties":false,"required":["pervasiveLuks2"],"properties":{"pervasiveLuks2":{"type":"object","additionalProperties":false,"required":["password"],"properties":{"password":{"$ref":"#/$defs/encryptionPassword"}}}}},"encryptionTPM":{"description":"TPM-Based Full Disk Encrytion.","type":"object","additionalProperties":false,"required":["tpmFde"],"properties":{"tpmFde":{"type":"object","additionalProperties":false,"required":["password"],"properties":{"password":{"$ref":"#/$defs/encryptionPassword"}}}}},"encryptionSwap":{"description":"Swap encryptions.","enum":["protected_swap","secure_swap","random_swap"]},"encryptionPassword":{"description":"Password to use when creating a new encryption device.","type":"string"},"encryptionCipher":{"description":"The value must be compatible with the --cipher argument of the command cryptsetup.","type":"string"},"encryptionKeySize":{"description":"The value (in bits) has to be a multiple of 8. The possible key sizes are limited by the used cipher.","type":"integer"},"encryptionPbkdFunction":{"enum":["pbkdf2","argon2i","argon2id"]},"filesystem":{"type":"object","additionalProperties":false,"properties":{"reuseIfPossible":{"description":"Try to reuse the existing file system. In some cases the file system could not be reused, for example, if the device is re-encrypted.","type":"boolean","default":false},"type":{"$ref":"#/$defs/filesystemType"},"label":{"description":"File system label.","type":"string"},"path":{"description":"Mount path.","type":"string","examples":["/var/log"]},"mountBy":{"title":"Mount by","description":"How to mount the device.","enum":["device","id","label","path","uuid"]},"mkfsOptions":{"description":"Options for creating the file system.","type":"array","items":{"type":"string"}},"mountOptions":{"description":"Options to add to the fourth field of fstab.","type":"array","items":{"type":"string"}}}},"filesystemType":{"anyOf":[{"$ref":"#/$defs/filesystemTypeAny"},{"$ref":"#/$defs/filesystemTypeBtrfs"}]},"filesystemTypeAny":{"enum":["bcachefs","btrfs","exfat","ext2","ext3","ext4","f2fs","jfs","nfs","nilfs2","ntfs","reiserfs","swap","tmpfs","vfat","xfs"]},"filesystemTypeBtrfs":{"description":"Btrfs file system.","type":"object","additionalProperties":false,"required":["btrfs"],"properties":{"btrfs":{"type":"object","additionalProperties":false,"properties":{"snapshots":{"description":"Whether to configrue Btrfs snapshots.","type":"boolean"}}}}}}}