com.vmware.nsx.model

Class AuthenticationPolicyProperties.Builder

java.lang.Object

com.vmware.nsx.model.AuthenticationPolicyProperties.Builder

Enclosing class:

AuthenticationPolicyProperties

public static final class AuthenticationPolicyProperties.Builder
extends java.lang.Object

Builder class for AuthenticationPolicyProperties.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of AuthenticationPolicyProperties.

Method Summary

Modifier and Type	Method and Description
AuthenticationPolicyProperties	build()
AuthenticationPolicyProperties.Builder	setApiFailedAuthLockoutPeriod(java.lang.Long apiFailedAuthLockoutPeriod) Once a lockout occurs, the account remains locked out of the API for this time period.
AuthenticationPolicyProperties.Builder	setApiFailedAuthResetPeriod(java.lang.Long apiFailedAuthResetPeriod) In order to trigger an account lockout, all authentication failures must occur in this time window.
AuthenticationPolicyProperties.Builder	setApiMaxAuthFailures(java.lang.Long apiMaxAuthFailures) Only applies to NSX Manager nodes.
AuthenticationPolicyProperties.Builder	setCliFailedAuthLockoutPeriod(java.lang.Long cliFailedAuthLockoutPeriod) Once a lockout occurs, the account remains locked out of the CLI for this time period.
AuthenticationPolicyProperties.Builder	setCliMaxAuthFailures(java.lang.Long cliMaxAuthFailures) Number of authentication failures that trigger CLI lockout format: int64
AuthenticationPolicyProperties.Builder	setDigits(java.lang.Long digits) Number of digits (0..9) expected in user password.
AuthenticationPolicyProperties.Builder	setHashAlgorithm(java.lang.String hashAlgorithm) Possible values are: AuthenticationPolicyProperties.HASH_ALGORITHM_SHA512 AuthenticationPolicyProperties.HASH_ALGORITHM_SHA256 Sets hash/cryptographic algorithm type for new passwords.
AuthenticationPolicyProperties.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
AuthenticationPolicyProperties.Builder	setLowerChars(java.lang.Long lowerChars) Number of lower case characters (a..z) expected in user password.
AuthenticationPolicyProperties.Builder	setMaximumPasswordLength(java.lang.Long maximumPasswordLength) Maximum number of characters allowed in password; user can not set their password of length greater than this parameter.
AuthenticationPolicyProperties.Builder	setMaxRepeats(java.lang.Long maxRepeats) Reject passwords which contain more than N same consecutive characters, like aaa or 7777.
AuthenticationPolicyProperties.Builder	setMaxSequence(java.lang.Long maxSequence) Reject passwords which contain more than N monotonic character sequences.
AuthenticationPolicyProperties.Builder	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 -
AuthenticationPolicyProperties.Builder	setMinimumUniqueChars(java.lang.Long minimumUniqueChars) Number of character changes in the new password that differentiate it from the old password.
AuthenticationPolicyProperties.Builder	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.
AuthenticationPolicyProperties.Builder	setRetryPrompt(java.lang.Long retryPrompt) Prompt user at most N times before returning with error.
AuthenticationPolicyProperties.Builder	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.
AuthenticationPolicyProperties.Builder	setSelf(SelfResourceLink self)
AuthenticationPolicyProperties.Builder	setSpecialChars(java.lang.Long specialChars) Number of special characters (!@#$&*..) expected in user password.
AuthenticationPolicyProperties.Builder	setUpperChars(java.lang.Long upperChars) Number of upper case characters (A..Z) expected in user password.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of AuthenticationPolicyProperties.

Method Detail

setLinks

public AuthenticationPolicyProperties.Builder setLinks(java.util.List<ResourceLink> links)

The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

links - New value for the property.

setSchema

public AuthenticationPolicyProperties.Builder 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.

Parameters:

schema - New value for the property.

setSelf

public AuthenticationPolicyProperties.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRetryPrompt

public AuthenticationPolicyProperties.Builder setRetryPrompt(java.lang.Long retryPrompt)

Prompt user at most N times before returning with error. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

retryPrompt - New value for the property.

setDigits

public AuthenticationPolicyProperties.Builder setDigits(java.lang.Long digits)

Number of digits (0..9) expected in user password.

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: int64

Parameters:

digits - New value for the property.

setHashAlgorithm

public AuthenticationPolicyProperties.Builder setHashAlgorithm(java.lang.String hashAlgorithm)

Possible values are:

• AuthenticationPolicyProperties.HASH_ALGORITHM_SHA512
• AuthenticationPolicyProperties.HASH_ALGORITHM_SHA256

Sets hash/cryptographic algorithm type for new passwords.

Parameters:

hashAlgorithm - New value for the property.

setLowerChars

public AuthenticationPolicyProperties.Builder setLowerChars(java.lang.Long lowerChars)

Number of lower case characters (a..z) expected in user password.

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: int64

Parameters:

lowerChars - New value for the property.

setMaxRepeats

public AuthenticationPolicyProperties.Builder setMaxRepeats(java.lang.Long maxRepeats)

Reject passwords which contain more than N same consecutive characters, like aaa or 7777. To disable the check, value should be set to 0. format: int64

Parameters:

maxRepeats - New value for the property.

setMaxSequence

public AuthenticationPolicyProperties.Builder setMaxSequence(java.lang.Long maxSequence)

Reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0. format: int64

Parameters:

maxSequence - New value for the property.

setMaximumPasswordLength

public AuthenticationPolicyProperties.Builder setMaximumPasswordLength(java.lang.Long maximumPasswordLength)

Maximum number of characters allowed in password; user can not set their password of length greater than this parameter. By default maximum length of password is 128 characters. format: int64

Parameters:

maximumPasswordLength - New value for the property.

setMinimumPasswordLength

public AuthenticationPolicyProperties.Builder 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 -

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.

By default minimum length of password is 12 characters and passwords less than 8 characters are never allowed. format: int64

Parameters:

minimumPasswordLength - New value for the property.

setMinimumUniqueChars

public AuthenticationPolicyProperties.Builder setMinimumUniqueChars(java.lang.Long minimumUniqueChars)

Number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0. format: int64

Parameters:

minimumUniqueChars - New value for the property.

setPasswordRemembrance

public AuthenticationPolicyProperties.Builder 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. To disable the check, value should be set to 0. format: int64

Parameters:

passwordRemembrance - New value for the property.

setSpecialChars

public AuthenticationPolicyProperties.Builder setSpecialChars(java.lang.Long specialChars)

Number of special characters (!@#$&*..) expected in user password.

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: int64

Parameters:

specialChars - New value for the property.

setUpperChars

public AuthenticationPolicyProperties.Builder setUpperChars(java.lang.Long upperChars)

Number of upper case characters (A..Z) expected in user password.

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: int64

Parameters:

upperChars - New value for the property.

setApiFailedAuthLockoutPeriod

public AuthenticationPolicyProperties.Builder setApiFailedAuthLockoutPeriod(java.lang.Long apiFailedAuthLockoutPeriod)

Once a lockout occurs, the account remains locked out of the API for this time period. Only applies to NSX Manager nodes. Ignored on other node types. format: int64

Parameters:

apiFailedAuthLockoutPeriod - New value for the property.

setApiFailedAuthResetPeriod

public AuthenticationPolicyProperties.Builder setApiFailedAuthResetPeriod(java.lang.Long apiFailedAuthResetPeriod)

In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period expires, the failed login count is reset to zero. Only applies to NSX Manager nodes. Ignored on other node types. format: int64

Parameters:

apiFailedAuthResetPeriod - New value for the property.

setApiMaxAuthFailures

public AuthenticationPolicyProperties.Builder setApiMaxAuthFailures(java.lang.Long apiMaxAuthFailures)

Only applies to NSX Manager nodes. Ignored on other node types. format: int64

Parameters:

apiMaxAuthFailures - New value for the property.

setCliFailedAuthLockoutPeriod

public AuthenticationPolicyProperties.Builder setCliFailedAuthLockoutPeriod(java.lang.Long cliFailedAuthLockoutPeriod)

Once a lockout occurs, the account remains locked out of the CLI for this time period. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified. format: int64

Parameters:

cliFailedAuthLockoutPeriod - New value for the property.

setCliMaxAuthFailures

public AuthenticationPolicyProperties.Builder setCliMaxAuthFailures(java.lang.Long cliMaxAuthFailures)

Number of authentication failures that trigger CLI lockout format: int64

Parameters:

cliMaxAuthFailures - New value for the property.

build

public AuthenticationPolicyProperties build()