public final class AuthenticationPolicyProperties
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
Modifier and Type | Class and Description |
---|---|
static class |
AuthenticationPolicyProperties.Builder
Builder class for
AuthenticationPolicyProperties . |
Modifier and Type | Field and Description |
---|---|
protected com.vmware.vapi.data.StructValue |
__dynamicStructureFields |
static java.lang.String |
HASH_ALGORITHM_SHA256 |
static java.lang.String |
HASH_ALGORITHM_SHA512 |
Modifier | Constructor and Description |
---|---|
|
AuthenticationPolicyProperties()
Default constructor.
|
protected |
AuthenticationPolicyProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends com.vmware.vapi.bindings.Structure> |
_convertTo(java.lang.Class<T> clazz) |
java.lang.String |
_getCanonicalName() |
static java.lang.String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal method, subject to change in future versions.
|
com.vmware.vapi.data.StructValue |
_getDataValue() |
com.vmware.vapi.data.DataValue |
_getDynamicField(java.lang.String fieldName) |
java.util.Set<java.lang.String> |
_getDynamicFieldNames() |
com.vmware.vapi.bindings.type.StructType |
_getType() |
boolean |
_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz) |
static AuthenticationPolicyProperties |
_newInstance(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
static AuthenticationPolicyProperties |
_newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
com.vmware.vapi.data.DataValue fieldValue) |
protected void |
_updateDataValue(com.vmware.vapi.data.StructValue structValue) |
void |
_validate() |
boolean |
equals(java.lang.Object obj) |
java.lang.Long |
getApiFailedAuthLockoutPeriod()
Once a lockout occurs, the account remains locked out of the API for this time
period.
|
java.lang.Long |
getApiFailedAuthResetPeriod()
In order to trigger an account lockout, all authentication failures must occur
in this time window.
|
java.lang.Long |
getApiMaxAuthFailures()
Only applies to NSX Manager nodes.
|
java.lang.Long |
getCliFailedAuthLockoutPeriod()
Once a lockout occurs, the account remains locked out of the CLI for this time
period.
|
java.lang.Long |
getCliMaxAuthFailures()
Number of authentication failures that trigger CLI lockout format: int64
|
java.lang.Long |
getDigits()
Number of digits (0..9) expected in user password.
|
java.lang.String |
getHashAlgorithm()
Possible values are:
HASH_ALGORITHM_SHA512
HASH_ALGORITHM_SHA256
Sets hash/cryptographic algorithm type for new passwords. |
java.util.List<ResourceLink> |
getLinks()
The server will populate this field when returing the resource.
|
java.lang.Long |
getLowerChars()
Number of lower case characters (a..z) expected in user password.
|
java.lang.Long |
getMaximumPasswordLength()
Maximum number of characters allowed in password; user can not set their
password of length greater than this parameter.
|
java.lang.Long |
getMaxRepeats()
Reject passwords which contain more than N same consecutive characters, like aaa
or 7777.
|
java.lang.Long |
getMaxSequence()
Reject passwords which contain more than N monotonic character sequences.
|
java.lang.Long |
getMinimumPasswordLength()
Minimum number of characters expected in password; user can not set their
password of length less than this parameter.
NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above - |
java.lang.Long |
getMinimumUniqueChars()
Number of character changes in the new password that differentiate it from the
old password.
|
java.lang.Long |
getPasswordRemembrance()
Limit using a password that was used in past; users can not set the same
password within the N generations.
|
java.lang.Long |
getRetryPrompt()
Prompt user at most N times before returning with error.
|
java.lang.String |
getSchema()
Schema for this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
SelfResourceLink |
getSelf() |
java.lang.Long |
getSpecialChars()
Number of special characters (!@#$&*..) expected in user password.
|
java.lang.Long |
getUpperChars()
Number of upper case characters (A..Z) expected in user password.
|
int |
hashCode() |
void |
setApiFailedAuthLockoutPeriod(java.lang.Long apiFailedAuthLockoutPeriod)
Once a lockout occurs, the account remains locked out of the API for this time
period.
|
void |
setApiFailedAuthResetPeriod(java.lang.Long apiFailedAuthResetPeriod)
In order to trigger an account lockout, all authentication failures must occur
in this time window.
|
void |
setApiMaxAuthFailures(java.lang.Long apiMaxAuthFailures)
Only applies to NSX Manager nodes.
|
void |
setCliFailedAuthLockoutPeriod(java.lang.Long cliFailedAuthLockoutPeriod)
Once a lockout occurs, the account remains locked out of the CLI for this time
period.
|
void |
setCliMaxAuthFailures(java.lang.Long cliMaxAuthFailures)
Number of authentication failures that trigger CLI lockout format: int64
|
void |
setDigits(java.lang.Long digits)
Number of digits (0..9) expected in user password.
|
void |
setHashAlgorithm(java.lang.String hashAlgorithm)
Possible values are:
HASH_ALGORITHM_SHA512
HASH_ALGORITHM_SHA256
Sets hash/cryptographic algorithm type for new passwords. |
void |
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.
|
void |
setLowerChars(java.lang.Long lowerChars)
Number of lower case characters (a..z) expected in user password.
|
void |
setMaximumPasswordLength(java.lang.Long maximumPasswordLength)
Maximum number of characters allowed in password; user can not set their
password of length greater than this parameter.
|
void |
setMaxRepeats(java.lang.Long maxRepeats)
Reject passwords which contain more than N same consecutive characters, like aaa
or 7777.
|
void |
setMaxSequence(java.lang.Long maxSequence)
Reject passwords which contain more than N monotonic character sequences.
|
void |
setMinimumPasswordLength(java.lang.Long minimumPasswordLength)
Minimum number of characters expected in password; user can not set their
password of length less than this parameter.
NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above - |
void |
setMinimumUniqueChars(java.lang.Long minimumUniqueChars)
Number of character changes in the new password that differentiate it from the
old password.
|
void |
setPasswordRemembrance(java.lang.Long passwordRemembrance)
Limit using a password that was used in past; users can not set the same
password within the N generations.
|
void |
setRetryPrompt(java.lang.Long retryPrompt)
Prompt user at most N times before returning with error.
|
void |
setSchema(java.lang.String schema)
Schema for this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setSelf(SelfResourceLink self) |
void |
setSpecialChars(java.lang.Long specialChars)
Number of special characters (!@#$&*..) expected in user password.
|
void |
setUpperChars(java.lang.Long upperChars)
Number of upper case characters (A..Z) expected in user password.
|
java.lang.String |
toString() |
public static final java.lang.String HASH_ALGORITHM_SHA512
public static final java.lang.String HASH_ALGORITHM_SHA256
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
public AuthenticationPolicyProperties()
protected AuthenticationPolicyProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
public java.util.List<ResourceLink> getLinks()
public void setLinks(java.util.List<ResourceLink> links)
links
- New value for the property.public java.lang.String getSchema()
public void setSchema(java.lang.String schema)
schema
- New value for the property.public SelfResourceLink getSelf()
public void setSelf(SelfResourceLink self)
self
- New value for the property.public java.lang.Long getRetryPrompt()
public void setRetryPrompt(java.lang.Long retryPrompt)
retryPrompt
- New value for the property.public java.lang.Long getDigits()
N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.
N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N digits.
N = 0, policy will be not applicable.
By default minimum 1 digit is required for a new password. format: int64public void setDigits(java.lang.Long digits)
N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.
N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N digits.
N = 0, policy will be not applicable.
By default minimum 1 digit is required for a new password. format: int64digits
- New value for the property.public java.lang.String getHashAlgorithm()
public void setHashAlgorithm(java.lang.String hashAlgorithm)
hashAlgorithm
- New value for the property.public java.lang.Long getLowerChars()
N < 0, to set minimum credit for having lower case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
N > 0, to set maximum credit for having lower case characters in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N lower case characters.
N = 0, policy will be not applicable.
By default minimum 1 lower case character is required for a new password. format: int64public void setLowerChars(java.lang.Long lowerChars)
N < 0, to set minimum credit for having lower case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
N > 0, to set maximum credit for having lower case characters in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N lower case characters.
N = 0, policy will be not applicable.
By default minimum 1 lower case character is required for a new password. format: int64lowerChars
- New value for the property.public java.lang.Long getMaxRepeats()
public void setMaxRepeats(java.lang.Long maxRepeats)
maxRepeats
- New value for the property.public java.lang.Long getMaxSequence()
public void setMaxSequence(java.lang.Long maxSequence)
maxSequence
- New value for the property.public java.lang.Long getMaximumPasswordLength()
public void setMaximumPasswordLength(java.lang.Long maximumPasswordLength)
maximumPasswordLength
- New value for the property.public java.lang.Long getMinimumPasswordLength()
if existing appliance
is configured with minimum_password_length
less than current
default value, then upgraded appliance will reset the configured setting back to
recommended default; which can be explicitly modified back to original value or
any other integer greater than or equal to supported minimum value.
VMware recommends to set strong passwords for systems and appliances,
further suggests to maintain strong minimum_password_length
value.
NSX resets this value to default and recommends to maintain upgraded default
value or above for password complexity requirement.
If any existing user
passwords are set with length of less than newly configured
minimum_password_length
, then its recommended to reset the user
passwords as per newly configured password complexity compliance.
If
existing minimum_password_length
is greater than or equal to
default value, which shall be retained as it is in newly upgraded appliance.
public void setMinimumPasswordLength(java.lang.Long minimumPasswordLength)
if existing appliance
is configured with minimum_password_length
less than current
default value, then upgraded appliance will reset the configured setting back to
recommended default; which can be explicitly modified back to original value or
any other integer greater than or equal to supported minimum value.
VMware recommends to set strong passwords for systems and appliances,
further suggests to maintain strong minimum_password_length
value.
NSX resets this value to default and recommends to maintain upgraded default
value or above for password complexity requirement.
If any existing user
passwords are set with length of less than newly configured
minimum_password_length
, then its recommended to reset the user
passwords as per newly configured password complexity compliance.
If
existing minimum_password_length
is greater than or equal to
default value, which shall be retained as it is in newly upgraded appliance.
minimumPasswordLength
- New value for the property.public java.lang.Long getMinimumUniqueChars()
public void setMinimumUniqueChars(java.lang.Long minimumUniqueChars)
minimumUniqueChars
- New value for the property.public java.lang.Long getPasswordRemembrance()
public void setPasswordRemembrance(java.lang.Long passwordRemembrance)
passwordRemembrance
- New value for the property.public java.lang.Long getSpecialChars()
N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.
N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N special case characters.
N = 0, policy will be not applicable.
By default minimum 1 special character is required for a new password. format: int64public void setSpecialChars(java.lang.Long specialChars)
N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.
N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N special case characters.
N = 0, policy will be not applicable.
By default minimum 1 special character is required for a new password. format: int64specialChars
- New value for the property.public java.lang.Long getUpperChars()
N < 0, to set minimum credit for having upper case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N upper case characters.
N = 0, policy will be not applicable.
By default minimum 1 upper case character is required for a new password. format: int64public void setUpperChars(java.lang.Long upperChars)
N < 0, to set minimum credit for having upper case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N upper case characters.
N = 0, policy will be not applicable.
By default minimum 1 upper case character is required for a new password. format: int64upperChars
- New value for the property.public java.lang.Long getApiFailedAuthLockoutPeriod()
public void setApiFailedAuthLockoutPeriod(java.lang.Long apiFailedAuthLockoutPeriod)
apiFailedAuthLockoutPeriod
- New value for the property.public java.lang.Long getApiFailedAuthResetPeriod()
public void setApiFailedAuthResetPeriod(java.lang.Long apiFailedAuthResetPeriod)
apiFailedAuthResetPeriod
- New value for the property.public java.lang.Long getApiMaxAuthFailures()
public void setApiMaxAuthFailures(java.lang.Long apiMaxAuthFailures)
apiMaxAuthFailures
- New value for the property.public java.lang.Long getCliFailedAuthLockoutPeriod()
public void setCliFailedAuthLockoutPeriod(java.lang.Long cliFailedAuthLockoutPeriod)
cliFailedAuthLockoutPeriod
- New value for the property.public java.lang.Long getCliMaxAuthFailures()
public void setCliMaxAuthFailures(java.lang.Long cliMaxAuthFailures)
cliMaxAuthFailures
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
_getType
in interface com.vmware.vapi.bindings.StaticStructure
public com.vmware.vapi.data.StructValue _getDataValue()
_getDataValue
in interface com.vmware.vapi.bindings.Structure
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
public void _validate()
_validate
in interface com.vmware.vapi.bindings.StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in interface com.vmware.vapi.bindings.StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
_hasTypeNameOf
in interface com.vmware.vapi.bindings.Structure
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
_convertTo
in interface com.vmware.vapi.bindings.Structure
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
_setDynamicField
in interface com.vmware.vapi.bindings.StaticStructure
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
_getDynamicField
in interface com.vmware.vapi.bindings.StaticStructure
public java.util.Set<java.lang.String> _getDynamicFieldNames()
_getDynamicFieldNames
in interface com.vmware.vapi.bindings.StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
_getCanonicalName
in interface com.vmware.vapi.bindings.Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static AuthenticationPolicyProperties _newInstance(com.vmware.vapi.data.StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
public static AuthenticationPolicyProperties _newInstance2(com.vmware.vapi.data.StructValue structValue)