Skip to content

Latest commit

 

History

History
45 lines (42 loc) · 4.3 KB

PoolDatasetCreate0.md

File metadata and controls

45 lines (42 loc) · 4.3 KB

# PoolDatasetCreate0

Properties

Name Type Description Notes
name string `encryption` when enabled will create an ZFS encrypted root dataset for `name` pool. There are 2 cases where ZFS encryption is not allowed for a dataset: 1) Pool in question is GELI encrypted. 2) If the parent dataset is encrypted with a passphrase and `name` is being created with a key for encrypting the dataset. `encryption_options` specifies configuration for encryption of dataset for `name` pool. `encryption_options.passphrase` must be specified if encryption for dataset is desired with a passphrase as a key. Otherwise a hex encoded key can be specified by providing `encryption_options.key`. `encryption_options.generate_key` when enabled automatically generates the key to be used for dataset encryption. [optional]
type string [optional] [default to 'FILESYSTEM']
volsize int `volsize` is required for type=VOLUME and is supposed to be a multiple of the block size. [optional]
volblocksize string `sparse` and `volblocksize` are only used for type=VOLUME. [optional]
sparse bool `sparse` and `volblocksize` are only used for type=VOLUME. [optional]
force_size bool [optional]
comments \RMoore\Truenas\Model\Comments [optional]
sync \RMoore\Truenas\Model\Sync [optional]
compression \RMoore\Truenas\Model\Compression [optional]
atime \RMoore\Truenas\Model\Atime [optional]
exec \RMoore\Truenas\Model\Exec [optional]
managedby \RMoore\Truenas\Model\Managedby [optional]
quota int [optional]
quota_warning \RMoore\Truenas\Model\QuotaWarning [optional]
quota_critical \RMoore\Truenas\Model\QuotaCritical [optional]
refquota int [optional]
refquota_warning \RMoore\Truenas\Model\RefquotaWarning [optional]
refquota_critical \RMoore\Truenas\Model\RefquotaCritical [optional]
reservation int [optional]
refreservation int [optional]
special_small_block_size \RMoore\Truenas\Model\SpecialSmallBlockSize [optional]
copies \RMoore\Truenas\Model\Copies [optional]
snapdir \RMoore\Truenas\Model\Snapdir [optional]
deduplication \RMoore\Truenas\Model\Deduplication [optional]
checksum \RMoore\Truenas\Model\Checksum [optional]
readonly \RMoore\Truenas\Model\Readonly [optional]
recordsize \RMoore\Truenas\Model\Recordsize [optional]
casesensitivity \RMoore\Truenas\Model\Casesensitivity [optional]
aclmode \RMoore\Truenas\Model\Aclmode [optional]
acltype \RMoore\Truenas\Model\Acltype [optional]
share_type string [optional] [default to 'GENERIC']
xattr \RMoore\Truenas\Model\Xattr [optional]
encryption_options \RMoore\Truenas\Model\EncryptionOptions1 [optional]
encryption bool `encryption` when enabled will create an ZFS encrypted root dataset for `name` pool. There are 2 cases where ZFS encryption is not allowed for a dataset: 1) Pool in question is GELI encrypted. 2) If the parent dataset is encrypted with a passphrase and `name` is being created with a key for encrypting the dataset. [optional] [default to false]
inherit_encryption bool [optional] [default to true]
user_properties \RMoore\Truenas\Model\UserProperty[] [optional]
create_ancestors bool [optional] [default to false]

[Back to Model list] [Back to API list] [Back to README]