Schema Properties
To define custom properties, navigate to Shares: Schema in the BUI or shares schema
in the CLI. The current schema is displayed as a list, and entries can be added or removed as needed. Each property has the following fields:
Table 4-67 Schema Property Fields
Field | Description |
---|---|
|
The CLI name for this property. This must contain only alphanumeric characters or the characters |
|
The BUI name for this property. This can contain arbitrary characters and is used in the help section of the CLI. |
|
The property type, for validation purposes. This must be one of the types described in the following table. |
The valid types for properties are:
Table 4-68 Valid Types for Properties
BUI Type | CLI Type | Description |
---|---|---|
String |
|
Arbitrary string data. This is the equivalent of no validation. |
Integer |
|
A positive or negative integer. |
Positive Integer |
|
A positive integer. |
Boolean |
|
A |
Email Address |
|
An email address. Only minimal syntactic validation is done. |
Hostname or IP |
|
A valid DNS hostname or IP (v4 or v6) address. |
Once defined, the properties are available under the General properties tab, using the description provided in the property table. Properties are identified by their CLI name, so renaming a property will have the effect of removing all existing settings on the system. A property that is removed and later renamed back to the original name will still refer to the previously set values. Changing the types of properties, while supported, may have undefined results on existing properties on the system. Existing properties will retain their current settings, even if they would be invalid given the new property type.