Skip to end of metadata
Go to start of metadata

 

The local authentication object allows an administrator to manage SBC Core user authorizations by assigning a user to one of the predefined groups.

For user authentication and group details, refer to Managing SBC Core Users and Accounts.

When a new user is created, the system generates a password for that account. The new user should change the default password after initial login.

Creating a user ID named "sonusadmin" via CLI is not allowed. If "sonusadmin" exists when upgrading to this release, it will automatically be removed.

For CLI details regarding changing passwords, refer to change-password page.

Group

Use this command to create or delete a user group.

You cannot delete a default user group.

 

Command Syntax

% set oam localAuth group <group name>

% show oam localAuth group

Command Parameter

ParameterLength/RangeDescription
group1-23 characters<group name> – The name of the user group. The characters #%^&(){}<>,/\;`[]=!$"*?|~ and SPACE are not allowed.

 

Rule-List

Command Syntax

% set oam localAuth rule-list <rule list name>
	cmdrule <string: min 1 character>
		access-operations <(string) | create | delete | exec | read | update>
		action <deny | permit>
		command <string>
		comment <string>
		context <string>
	group <group name>
	rule <string: min 1 character>
		access-operations <(string) | create | delete | exec | read | update>
		action <deny | permit>
		comment <string>
		context <string>
		module-name <string>
		path <string>
		rpc-name <string>

 

Command Parameters

ParameterDescription
rule-list<rule list name> – The unique rule-list name.
cmdrule

<command rule> – The space-separated command rule to take action against.

  • access-operations <(string) | create | delete | exec | read | update>The access operation to associate with this command rule.
  • action – Choose to deny or permit the specified command.
    • deny
    • permit
  • command <string> – The command to take action against.
  • comment <string> – Textual description of this command rule.
  • context <string>Use * to match all possible values, or specify the agent that is requesting access, for example, netconf for NETCONF, cli for CLI and webui for Web UI.
group<group name> – The name of the user group to associate with this rule-list. If not selected, this parameter defaults to the group that corresponds to the current level of access of this current session.
rule
 The rule object.
  • access-operations <(string) | create | delete | exec | read | update>
  • action <deny | permit>The access control action to associate with the rule. If a rule matches a particular request, use this flag to determine whether to permit or deny the request.
  • comment <string>Textual description of the rule-list rule.
  • context <string>Use * to match all possible values, or specify the agent that is requesting access, for example, netconf for NETCONF, cli for CLI and webui for Web UI.
  • module-name <string>Name of the module associated with this rule.
  • path <string>
  • rpc-name <string>

User

Command Syntax

% set oam localAuth user <user name>
	accountAgingState <disabled  |  enabled>
	accountRemovalState <disabled  |  enabled>
	group <Administrator | Calea | FieldService | Guest | Operator | SecurityAuditor>
	interactiveAccess  <disabled  |  enabled>
	m2mAccess <disabled  |  enabled>
	passwordAgingState <disabled  |  enabled>
	passwordLoginSupport <disabled  |  enabled>

% show oam localAuth
	displaylevel
	group
	rule-list
	user

% delete oam localAuth user <user name>

Command Parameters

Info

Refer to Account Management - CLI for system-level configuration of OS account aging, account aging, account removal, brute-force attack, maximum number of sessions, password aging and session idle timeout.

Table : Local Authentication Parameters

Parameter

Description

user

Specifies the name of the group user.

accountAgingState

The account aging state for a particular user.

  • disabled
  • enabled (default)
accountRemovalState

Use this flag to enable/disable the account removal feature for this user.

  • disabled
  • enabled (default)

 

group

Use this control to specify user authentication group type:

  • Administrator  
  • Calea
  • FieldService  
  • Guest
  • Operator
  • SecurityAuditor

NOTE: For guidance with adding users to the SBC, refer to Managing SBC Core Users and Accounts.

interactiveAccess

When enabled, this flag allows the specified user access to interactive interfaces such as CLI and EMA.

  • disabled  
  • enabled (default)
m2mAccess

 Enable this flag to allow the specified user machine-to-machine access to REST API. For REST API details, refer to REST API User's Guide.

  • disabled (Default for all users except Administrator and Calea groups)
  • enabled (Default for Administrator and Calea group users)
passwordAgingState

The password aging state for the specified user.

  • disabled
  • enabled (default)
passwordLoginSupport

Enable flag to allow specified user to login using password.

  • disabled
  • enabled (default)

displaylevel

To display different levels of output information in show commands.

 

Command Example

The following example shows current authorizations for configured users.

> show status oam localAuth user
userStatus admin {
    currentStatus Enabled;
    userId        3000;