sitesec
LocalUser

Local User.



public class LocalUser

Properties
access The value of tmnxUserAccess specifies the type of access the the user is permitted. To allow the user access to the console, FTP or SNMP, set the corresponding bit in tmnxUserAccess. Reset the bit to deny the access. 'li' access allows this user to access CLI commands in the Lawful Intercept (LI) context. The 'li' bit can only be modified from the SNMPv3 'li' context. The 'netconf' bit allows this user to make netconf request. The 'grpc' bit allows this user to connect to the box via gRPC session. The 'grpc' bit is only applicable to SR nodes from version 15.0.

type=long
default=unspecified
Displayed(tab/group)=Access
bits=
    0x800: ne3s - NE3S
    0x400: nwi3 - NWI3
    0x200: linux - Linux
    0x80: console - Console
    0x40: ftp - FTP
    0x20: snmp - SNMP
    0x10: li - LI
    0x8: tl1 - TL1
    0x4: grpc - GRPC
    0x2: netconf - NETCONF

accessPrivilege Access Privilege added for PSS.

type=sitesec.AccessPrivilege
default=observer
Displayed(tab/group)=Access Privilege (/PSS Specific Attributes), Authorization Level (TL1)

allowedIpAddresses

type=string
default=
Displayed(tab/group)=Allowed IP Addresses (TL1)

attemptedLogins The value of tmnxUserAttemptedLogins indicates the number of times the user has attempted to login irrespective of whether the login succeeded or failed.

type=long
access=read-only
default=0
Displayed(tab/group)=Attempted Logins (Statistics)

consoleCannotChangePassword When the value of tmnxUserConsoleCannotChangePswd is 'true', the user does not have the privilege to change the password for console and FTP login. When the value of tmnxUserConsoleCannotChangePswd is 'false', the user has the privilege to change the password for console and FTP login.

type=generic.TruthValue
default=false
Displayed(tab/group)=Console Cannot Change Password (/Console Login Permissions), User Cannot Change Password (TL1)

consoleLoginExecFile The value of consoleLoginExecFile specifies the file that should be executed whenever the user successfully logs in to a console session.

type=string
default=
minimum=0
maximum=200
Displayed(tab/group)=Console Login Exec File (/Console Login Permissions)

consoleMemberProfile1 The value of tmnxUserConsoleMemberProfile1 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=default
minimum=0
maximum=32
Displayed(tab/group)=Profile 1 (Console Profiles)

consoleMemberProfile2 The value of tmnxUserConsoleMemberProfile2 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Profile 2 (Console Profiles)

consoleMemberProfile3 The value of tmnxUserConsoleMemberProfile3 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Profile 3 (Console Profiles)

consoleMemberProfile4 The value of tmnxUserConsoleMemberProfile4 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Profile 4 (Console Profiles)

consoleMemberProfile5 The value of tmnxUserConsoleMemberProfile5 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Profile 5 (Console Profiles)

consoleMemberProfile6 The value of tmnxUserConsoleMemberProfile6 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Profile 6 (Console Profiles)

consoleMemberProfile7 The value of tmnxUserConsoleMemberProfile7 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Profile 7 (Console Profiles)

consoleMemberProfile8 The value of tmnxUserConsoleMemberProfile8 specifies a user profile that the user has access to. This profile must be a valid row entry in tmnxUserProfileTable. Each user can access a maximum of 8 user profiles. The value of the n-th user profile can be set only if all previous user profiles (1 through (n-1)) are non-empty strings. The order of the user profiles is important. The first user profile has highest precedence, followed by the second and so on.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Profile 8 (Console Profiles)

consoleNewPasswordAtLogin When the value of tmnxUserConsoleNewPswdAtLogin is 'true', the will be forced to change his password at the next console or FTP login. When the value of tmnxUserConsoleNewPswdAtLogin is 'false', the will not be forced to change his password at the next console or FTP login.

type=generic.TruthValue
default=false
Displayed(tab/group)=Console New Password At Login (/Console Login Permissions)

engineId User Engine Id.

type=string
access=read-only
default=0

homeDirectory The value of tmnxUserHomeDirectory specifies the local home directory for the user for console and FTP access.

type=string
default=
minimum=0
maximum=200
Displayed(tab/group)=Home Directory (/File System Permissions)

isPasswordEncrypted When the value of isPasswordEncrypted is 'true', the password specified by tmnxUserPassword is in the encrypted form. When the value of tmnxUserPasswordEncrypted is 'false', the password specified by tmnxUserPassword is in plain text. tmnxUserPassword and tmnxUserPasswordEncrypted, which indicates whether or not the password string is encrypted, must be set together in the same SNMP request PDU or else the set request will fail with an inconsistentValue error.

type=generic.TruthValue
default=true

isRestrictedToHome When the value of tmnxUserRestrictedToHome is 'true', the user is not allowed to navigate to directories above his home directory for file access. When the value of tmnxUserRestrictedToHome is 'false', the user is allowed access to directories above his home directory.

type=generic.TruthValue
default=false
Displayed(tab/group)=Restrict to Home (/File System Permissions)

isSaveWhenRestricted When the value of tmnxUserSaveWhenRestricted is 'true', the user is allowed to execute all configuration save operations, even if the tmnxUserRestrictedToHome set to 'true'. When the value of tmnxUserSaveWhenRestricted is 'false',the user is not allowed to execute all configuration save operations, if the tmnxUserRestrictedToHome set to 'true'.

type=generic.TruthValue
default=false
Displayed(tab/group)=Save When Restricted (/File System Permissions)

lastLogin

type=Date

linuxOldPassword The value of linuxOldPassword specifies the old password used to authenticate the user for Linux access.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Old Password (Linux)

linuxPassword The value of linuxPassword specifies the password used to authenticate the user for Linux access.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=New Password (Linux)

linuxPassword2 The value of linuxPassword2 specifies the password used to authenticate the user for Linux access.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Confirm New Password (Linux)

loginFailures

type=int

ne3sPassword NE3S password

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=NE3S Password (/Set NE3S Password)

ne3sPassword2 NE3S password2

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Confirm NE3S Password (/Set NE3S Password)

nwi3Password NWI3 password.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=LTE OMS Password (/Set NWI3 Password)

nwi3Password2 NWI3 password2

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Confirm LTE OMS Password (/Set NWI3 Password)

password The value of password specifies the password used to authenticate the user for console and FTP access. tmnxUserPassword and tmnxUserPasswordEncrypted, which indicates whether or not the password string is encrypted, must be set together in the same SNMP request PDU or else the set request will fail with an inconsistentValue error.

type=string
default=
minimum=0
maximum=129
Displayed(tab/group)=Password (/Set New Password (Console and/or FTP)), Password (TL1)

password2 The value of password2 specifies the password used to authenticate the user for console and FTP access. tmnxUserPassword and tmnxUserPasswordEncrypted, which indicates whether or not the password string is encrypted, must be set together in the same SNMP request PDU or else the set request will fail with an inconsistentValue error.

type=string
default=
minimum=0
maximum=129
Displayed(tab/group)=Confirm Password (/Set New Password (Console and/or FTP)), Confirm Password (TL1)

passwordAging The value of passwordAging specifies number of days a user password is valid before the user must change the password. If the value of the object is set to '65535', password aging is disabled for this user. If the value of the object is not '0', it will take precedence over the value of aging in Site Password Policy. If the value of the object is '0', the behavior will be dependent upon aging in Site Password Policy."

type=int
default=0
minimum=0
maximum=65535
units=days
Displayed(tab/group)=Password Aging (/Set New Password (Console and/or FTP))

passwordAgingRemaining

type=string
access=read-only
units=days
Displayed(tab/group)=Password Aging Remaining (TL1)

passwordChangeTime The value of passwordChangeTime indicates the value of sysUpTime when the login password was last changed.

type=Time
access=read-only
default=0
Displayed(tab/group)=Password Last Change Time (Statistics)

passwordChangedDate The value of passwordChangedDate specifies the calendar date and time when the login password was last changed.

type=string
access=read-only
default=unknown
maximum=252
Displayed(tab/group)=Password Last Change Date and Time (Statistics)

passwordExpirationDate The value of passwordExpirationDate specifies the calendar date and time when login password will be expire. If password aging is disabled, '1970-1-1,0:0:0.0,+0:0' is returned.

type=string
access=read-only
default=unknown
maximum=252

rowStatus

type=sitesec.RowStatus
default=enabled
Displayed(tab/group)=Status (/PSS Specific Attributes)

securityModel Security Model.

type=security.SnmpSecurityModel
access=read-only
default=snmpv3

sessionInactivityTimeout

type=int
default=0
minimum=0
maximum=999
units=minutes
Displayed(tab/group)=Session Inactivity Timeout (/PSS Specific Attributes), Session Inactivity Timeout (TL1)

snmpAccessPrivilege Access Privilege added for PSS.

type=sitesec.SNMPAccessPrivilege
default=AdminGroup
Displayed(tab/group)=Access Privilege (SNMPv3/PSS Specific Attributes)

snmpAuthKeyChange SNMP Auth key Change.

type=string
access=read-only
default=

snmpAuthPassword SNMP Auth Password.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=New Authentication Password (SNMPv3/Set New Authentication Password)

snmpAuthPassword2 SNMP Auth Password2.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Confirm New Auth Password (SNMPv3/Set New Authentication Password)

snmpAuthProtocol SNMP Authorization Protocol.

type=security.SnmpAuthenticationType
default=none
Displayed(tab/group)=Authentication Protocol (SNMPv3)

snmpCloneFromUser SNMP Clone from user.

type=string
access=read-only
default=

snmpGroupStatus SNMP Group Status.

type=generic.SnmpRowStatus
access=read-only
default=notReady

snmpOwnKeyChangeState SNMP Own Key Change State

type=security.SnmpOwnKeychangeState
access=read-only
default=none

snmpPrivKeyChange SNMP Private Key Change

type=string
access=read-only
default=

snmpPrivPassword SNMP Private password.

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=New Privacy Password (SNMPv3/Set New Privacy Password)

snmpPrivPassword2 SNMP Private password2

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Confirm New Privacy Password (SNMPv3/Set New Privacy Password)

snmpPrivProtocol SNMP Privacy protocol.

type=security.SnmpPrivacyType
default=none
Displayed(tab/group)=Privacy Protocol (SNMPv3)

snmpRowStatus

type=sitesec.RowStatus
default=enabled
Displayed(tab/group)=Status (SNMPv3/PSS Specific Attributes)

snmpSecurityLevel SNMP Security level.

type=security.SnmpSecurityLevel
access=read-only
default=noAuthNoPrivacy

snmpUserStatus SNMP User Status.

type=generic.SnmpRowStatus
access=read-only
default=notReady

snmpUserStatusDestroy Snmp User Status Destroy.

type=generic.SnmpRowStatus
access=read-only
default=notReady

successfulLogins The value of successfulLogins indicates the number of times the user has successfully logged in.

type=long
access=read-only
default=0
Displayed(tab/group)=Successful Logins (Statistics)

userAllowedStatus

type=string
access=read-only
Displayed(tab/group)=User Allowed Status (TL1)

userAuthMethServerPubKeyOnly The value of userAuthMethServerPubKeyOnly object specifies the publickey only authentication method that the ssh server accepts towards the client. When the value of userAuthMethServerPubKeyOnly is set to 'system', the system configuration is used.

type=sitesec.UserAuthMethod
default=system
Displayed(tab/group)=Public Key authentication method from Server to Client

userIdAgingInterval

type=int
default=60
minimum=0
maximum=999
units=days
Displayed(tab/group)=User ID Aging Interval (TL1)

userLocalLockout When the value of tmnxUserConsoleCannotChangePswd is 'true', the user does not have the privilege to change the password for console and FTP login. When the value of tmnxUserConsoleCannotChangePswd is 'false', the user has the privilege to change the password for console and FTP login.

type=generic.TruthValue
default=true
Displayed(tab/group)=Console User Local Lockout (/Console Login Permissions)

userLoginStatus

type=string
access=read-only
Displayed(tab/group)=User Login Status (TL1)

vacmGroupName VACM Group Name.

type=string
access=read-only
default=

 
Overridden Properties
displayedName Displayed Name.

access=read-create
minimum=1
maximum=32

id

maximum=256

 
Properties inherited from policy.PolicyDefinition
configurationAction, configurationMode, discoveryState, displayedName, distributionMode, isMaster, lastSyncTime, numberOfUnderlyingPolicyItems, origin, policyMode, policySyncGroupPointer, policyType
 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

clearPasswordHistory

This method clears the password history of one or more users, allowing them to reuse any password that they previously used.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
aInLocalUserList : List (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sitesec.LocalUser.clearPasswordHistoryException

unlockUser

This method clears any current lockout for the selected users. Even if there is no lockout, any attempt counts, exponential backoff, etc., are reset to '0'.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
aInLocalUserList : List (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
sitesec.LocalUser.unlockUserException
Methods inherited from policy.PolicyDefinition
distribute, distributeUsingGroups, distributeV2, evaluatePolicy, findGlobal, findLocal, findReleased, getSyncTaskResult, resetToReleasedPolicy, setConfigurationModeToDraft, setConfigurationModeToReleased, setDistributionModeToLocalEditOnly, setDistributionModeToSyncWithGlobal, syncTo, syncToLocalWithResync
 
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7701 CPAA
7705 SAR
7705 SAR H
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Product Specifics
7210 SAS D (all versions)
7210 SAS D 20.0.0
7210 SAS D 21.0.0
7210 SAS D 22.0.0
7210 SAS D 23.0.0
7210 SAS D 24.0.0
7210 SAS D 25.0.0
7210 SAS Dxp (all versions)
7210 SAS Dxp 20.0
7210 SAS Dxp 21.0
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
7210 SAS E (all versions)
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS (all versions)
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7701 CPAA (all versions)
7701 CPAA 8.0
7705 SAR Gen 2 (all versions)
7705 SAR Gen 2 25.0
7705 SAR H (all versions)
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR (all versions)
7705 SAR 20.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR (all versions)
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS (all versions)
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 (all versions)
DC 7850 (all versions)
DC VSC (all versions)