Overview Package Class Deprecated Help

security
TSecurityManager

TSecurityManager is used to manage security related information such as users, groups, roles, and spans. Other general parameters such as security messages and sessions are managed through this object.

public class TSecurityManager

Properties
accountValidityPeriod

type=int
default=180
minimum=0
maximum=365
units=days
Displayed(tab/group)=Account Expiry (/Expiry Periods)
advancePasswdExpirNotification

type=int
default=10
minimum=0
maximum=365
units=days
Displayed(tab/group)=Advance Password Expiry Notification (/Expiry Periods)
authFailureNotificationSubject

type=string
default=Authentication Failure
minimum=0
maximum=80
Displayed(tab/group)=E-mail Subject (E-mail/Authentication Failure Actions)
authFailureNotificationText

type=string
default=Enter authentication failure e-mail notification text here.
minimum=0
maximum=1024
Displayed(tab/group)=E-mail text (E-mail/Authentication Failure Actions)
defaultSystemGroupAttributePtr The "defaultSystemGroupAttributePtr" points to a specific group that represents the default group to use for temporary users. Temporary users (or remote only users) are bound to this group when the AAA server (RADIUS, TACACS+, ..) cannot send the authorized group name to NFM-P.

Note that if "defaultSystemGroupAttributePtr" is not assigned to a group, the overall authentication will fail for AAA servers that are capable of sending security groups to NFM-P. When a AAA service is capable of sending NFM-P user group when remote authentication succeeds, this default group is ignored. See SamJaasLogin.config for information.

type=Pointer
default=
Displayed(tab/group)=Group (/Default External User Group)
fromEmailAddress

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=E-mail Address (E-mail/Outgoing E-mail Server (SMTP))
guiTimeoutMinutes

type=int
default=15
minimum=0
maximum=9999
units=minutes
Displayed(tab/group)=Non-Web Client Timeout (/Expiry Periods)
mailUserId

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=E-mail User Name (E-mail/Outgoing E-mail Server (SMTP))
mailUserPasswd Note: The password for the out going mail server is not visible outside of the NFM-P server.

type=string
default=
minimum=0
maximum=212
Displayed(tab/group)=E-mail User Password (E-mail/Outgoing E-mail Server (SMTP))
minUserNameLengthAllowed

type=int
default=1
minimum=1
maximum=40
Displayed(tab/group)=Minimum User Name Length Allowed (/User Name)
numAuthFailuresBeforeLockout

type=int
default=5
minimum=0
maximum=10
Displayed(tab/group)=Attempts before lockout (E-mail/Authentication Failure Actions)
numAuthFailuresBeforeNotification

type=int
default=3
minimum=0
maximum=10
Displayed(tab/group)=Attempts before e-mail (E-mail/Authentication Failure Actions)
outGoingServerMail

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Server (E-mail/Outgoing E-mail Server (SMTP))
passwordValidityPeriod

type=int
default=90
minimum=0
maximum=365
units=days
Displayed(tab/group)=Password Expiry (/Expiry Periods)
reserveAdminEnabled

type=boolean
default=false
Displayed(tab/group)=Reserve Administrator Login
security.ContactInfo-Set type=Children-Set
security.ScopeOfCommandProfile-Set type=Children-Set
security.ScopeOfCommandRole-Set type=Children-Set
security.Span-Set type=Children-Set
security.SpanOfControlProfile-Set type=Children-Set
security.User-Set type=Children-Set
security.UserBase-Set type=Children-Set
security.UserGroup-Set type=Children-Set
statement

DEPRECATED: 17.3 - The security statment is set in the NSP launchpad and is not specific to the NFM-P client
type=string
default=Enter security statement here (do not forget to enable)
minimum=0
maximum=2000
statementEnabled

DEPRECATED: 17.3 - The security statment is set in the NSP launchpad and is not specific to the NFM-P client
type=boolean
default=false
suspendedNotificationSubject

type=string
default=Account Suspended
minimum=0
maximum=80
Displayed(tab/group)=E-mail Subject (E-mail/Suspended Account Actions)
suspendedNotificationText

type=string
default=Enter account suspended e-mail notification text here.
minimum=0
maximum=1024
Displayed(tab/group)=E-mail text (E-mail/Suspended Account Actions)
testEmailMessage

type=string
default=Enter a test message here.
minimum=0
maximum=1024
Displayed(tab/group)=Test Message (E-mail/Test E-mail)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

getServerVersion

This method retrieves the NFM-P Server Version.
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
serverVersion : string -

getUXPrefs

Retrieve UX specific configuration.
Input Parameters:
prefName : string - The preference name.
userName : string - The user name.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
contents : string - The preferences.
Exceptions:
security.TSecurityManager.getUXPrefsException

reAssignUser

This method is used reassign a scheduled task from one User to another User.
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.
newUser : string -
infoList : List (generic.CommonManagedEntityInformation) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

removeUXPrefs

Save UX based preferences.
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.
prefName : string - The preference name.
userName : string - The user name.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
security.TSecurityManager.removeUXPrefsException

resumeUser

This method is used to resume a User account that was previously suspended.
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.
userName : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

saveUXPrefs

Save UX based preferences.
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.
prefName : string - The preference name.
userName : string - The user name.
contents : string - The preferences.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string - The full name of the newly created preference.
Exceptions:
security.TSecurityManager.saveUXPrefsException

suspendUser

This method is used to suspend an existing User account.
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.
userName : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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
7705 SAR
7705 SAR H
7701 CPAA
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS