Overview Package Class Deprecated Help

security
UserGroup

The UserGroup class contains configuration items common to a group of users. Items such as scope of command profile, and account expiry items are managed through this class.

public class UserGroup

Properties
accountExpiryEnabled The Account Expiry parameter specifies whether the NFM-P should track how long an account remains dormant. When the parameter is enabled and a user account is not used for the number of days specified in the Account Expiry (days) parameter, the user account will be suspended.

type=boolean
default=false
Displayed(tab/group)=Account Expiry (/Expiry Periods)
description

type=string
default=user group
minimum=0
maximum=80
Displayed(tab/group)=Description
displayedWorkspaces Minimum list of workspaces displayed in the user's drop-down If the list is empty on creation (through OSS) of a user group, the System_Default_All workspace will be added. This list is not allowed to be empty.

type=List (Pointer)
forceWorkspaces When true, the users can not change the list of workspaces in their drop-down, nor change which one is their default workspace

type=boolean
default=false
Displayed(tab/group)=Allow Mandatory Workspaces Only (/Mandatory Workspaces)
groupName

type=string
access=read-create
default=
minimum=5
maximum=40
Mandatory on create
Displayed(tab/group)=User Group
groupState

type=security.GroupLoginState
default=active
Displayed(tab/group)=User Group State
guiTimeoutMinutes

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

type=boolean
default=false
Displayed(tab/group)=Non-Web Override Global Timeout (/Expiry Periods)
localAuthenticationOnly
  1. This attribute specifies whether NFM-P Server local authentication only is applicable to the group.
  2. If this attribute is false, remote authentication (e.g. Radius) can be applied to the group.

type=boolean
default=false
Displayed(tab/group)=Apply Local Authentication Only
maxOssSessionsAllowed Maximum number of OSS sessions, 0 means there is no limit. This property applies only to individual remote users. The limit applies separately to JMS and http(s) sessions.

type=int
default=0
minimum=0
maximum=30
Displayed(tab/group)=Maximum OSS Sessions Allowed (/Remote Users)
maxSessionsAllowed Maximum number of operator positions for a remote user belonging to this User Group. This property applies only to individual remote users. 0 means that there is no limit.

type=int
default=0
Displayed(tab/group)=Maximum User Operator Positions Allowed (/Remote Users)
maxUserSessionsAllowed Maximum number of operator positions allowed for this user group. 0 means that there is no limit.

type=int
default=0
Displayed(tab/group)=Maximum User Group Operator Positions Allowed
ossRequestTimeout The maximum amount of time (in seconds) an OSS XML API request by a user in this group will wait to begin processing before timing out. The property applies only to remotely-authenticated users (eg. RADIUS/TACACS).

type=int
default=60
minimum=0
maximum=600
Displayed(tab/group)=OSS Request Timeout (seconds) (/Remote Users)
passwordExpiryEnabled

type=boolean
default=false
Displayed(tab/group)=Password Expiry (/Expiry Periods)
priority The priority of requests that are processed in NFM-P Server. This property applies only to remote users.

type=security.PriorityType
default=low
Displayed(tab/group)=OSS Request Priority (/Remote Users)
scopeOfCommandProfileId

DEPRECATED: 12.0R1 - Use scopeOfCommandProfilePointer instead.
type=long
default=0
Displayed(tab/group)=Scope of Command Profile ID (/Scope of Command)
scopeOfCommandProfileName

type=string
access=read-only
default=
maximum=80
Displayed(tab/group)=Scope of Command Profile Name (/Scope of Command)
scopeOfCommandProfilePointer The fullName of the Scope Of Command Profile.

type=Pointer
default=
Displayed(tab/group)=Scope of Command Profile (/Scope of Command)
spanOfControlProfileId

DEPRECATED: 12.0R1 - Use spanOfControlProfilePointer instead.
type=long
default=0
Displayed(tab/group)=Span of Control Profile ID (/Span of Control)
spanOfControlProfileName

type=string
access=read-only
default=
maximum=80
Displayed(tab/group)=Span of Control Profile Name (/Span of Control)
spanOfControlProfilePointer The fullName of the Span Of Control Profile.

type=Pointer
default=
Displayed(tab/group)=Span of Control Profile (/Span of Control)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

getUXPrefs

Retrieve UX specific configuration.
Input Parameters:
instanceFullName : string - the full name of the object.
prefName : string - The preference 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.UserGroup.getUXPrefsException

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.
instanceFullName : string - the full name of the object.
prefName : string - The preference name.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
security.UserGroup.removeUXPrefsException

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.
instanceFullName : string - the full name of the object.
prefName : string - The preference 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.UserGroup.saveUXPrefsException