system.security.update¶
Update System Security Service Configuration.
This method is used to change the FIPS, STIG, and local account policies for TrueNAS Enterprise. These features are not available in community editions of TrueNAS.
No Additional Items
Tuple Validation
Parameter 1: system_security_update
system_security_update
Type: objectNo Additional Properties
Enable Fips
Type: booleanWhen set, enables FIPS mode.
Enable Gpos Stig
Type: booleanWhen set, enables compatibility with the General Purpose Operating System STIG.
Min Password Age
The number of days local users will have to wait before they will be
 allowed to change password again. One reason for setting this parameter is
 to prevent users from bypassing password history restrictions by rapidly
 changing their passwords. The value of None means that there is no
 minimum password age.
Value must be strictly greater than 0
Max Password Age
The number of days after which a password is considered to be expired. After
 expiration no login will be possible for the user. The user should contact the
 administrator for a password reset. The value of None means that there is no
 maximum password age, and password aging is disabled. NOTE: user passwords will never
 expire if password aging is disabled.
Value must be greater or equal to 7 and lesser or equal to 365
Password Complexity Ruleset
The password complexity ruleset defines what character types are required
 for passwords used by local accounts. The value of None means that there
 are no password complexity requirements. List items indicate a requirement
 for at least one character in the password to be of the specified character
 set type.
All items must be unique
No Additional ItemsEach item of this array must be:
Must be one of:
- "UPPER"
- "LOWER"
- "NUMBER"
- "SPECIAL"
Min Password Length
The minimum length of passwords used for local accounts. The value of None
 means that there is no minimum password length.
Value must be greater or equal to 8
Password History Length
The number of password generations to keep in history for checks against
 password reuse for local user accounts. The value of None means that history checks
 for password reuse are not performed.
Value must be greater or equal to 1 and lesser or equal to 10
SystemSecurityEntry
Type: objectNo Additional Properties
Id
Type: integerEnable Fips
Type: booleanWhen set, enables FIPS mode.
Enable Gpos Stig
Type: booleanWhen set, enables compatibility with the General Purpose Operating System STIG.
Min Password Age
Default: nullThe number of days local users will have to wait before they will be
 allowed to change password again. One reason for setting this parameter is
 to prevent users from bypassing password history restrictions by rapidly
 changing their passwords. The value of None means that there is no
 minimum password age.
Value must be strictly greater than 0
Max Password Age
Default: nullThe number of days after which a password is considered to be expired. After
 expiration no login will be possible for the user. The user should contact the
 administrator for a password reset. The value of None means that there is no
 maximum password age, and password aging is disabled. NOTE: user passwords will never
 expire if password aging is disabled.
Value must be greater or equal to 7 and lesser or equal to 365
Password Complexity Ruleset
Default: nullThe password complexity ruleset defines what character types are required
 for passwords used by local accounts. The value of None means that there
 are no password complexity requirements. List items indicate a requirement
 for at least one character in the password to be of the specified character
 set type.
All items must be unique
No Additional ItemsEach item of this array must be:
Must be one of:
- "UPPER"
- "LOWER"
- "NUMBER"
- "SPECIAL"
Min Password Length
Default: nullThe minimum length of passwords used for local accounts. The value of None
 means that there is no minimum password length.
Value must be greater or equal to 8
Password History Length
Default: nullThe number of password generations to keep in history for checks against
 password reuse for local user accounts. The value of None means that history checks
 for password reuse are not performed.
Value must be greater or equal to 1 and lesser or equal to 10
Required roles: SYSTEM_SECURITY_WRITE