This cmdlet adds a user account to the Lenovo XClarity Administrator server.

Note: You cannot pipe objects to this cmdlet.


Add-LXCAUserAccount [-Connection Connection] 
                     -UserName String 
                     -Password SecureString
                     -RoleGroups String[]
                    [-PasswordChangeFirstAccess Bool]
                    [-Description String]


-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-Username String
Specifies the user ID of the new user account.
-Password SecureString
Specifies the password of the new user account.
-RoleGroups String[]
Specifies one or more role groups to which the new user account is to be assigned.
The following role groups are predefined in XClarity Administrator. You can also create customized role groups to manage authorization and access to resources on the web interface.
  • LXC-ADMIN. Includes the lxca-admin role.

  • LXC-RECOVERY. Includes the lxc-recovery role.

  • LXC-SECURITY-ADMIN. Includes the lxc-security-admin role.

  • LXC-SUPERVISOR. Includes the lxc-supervisor role.

  • LXC-OPERATOR. Includes the lxc-operator role.

  • LXC-FW-ADMIN. Includes the lxc-fw-admin role.

  • LXC-OS-ADMIN. Includes the lxc-os-admin role.

  • LXC-HW-ADMIN. Includes the lxc-hw-admin role.

  • LXC-SERVICE-ADMIN. Includes the lxc-service-admin role.

  • LXC-HW-MANAGER. Includes the lxc-hw-manager role.

-PasswordChangeFirstAccess Bool
Specifies that the password must be changed the first time it is used. The default value is True.
-Description String
Specifies a description for the new user account.
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.


This cmdlet returns a UserAccount object.


The following example creates a user account.

$cred = Get-Credential
Connect-LXCA -Host -Credential $cred

$pwd = ConvertTo-SecureString "password" -AsPlainText Force
$account = Add-LXCAUserAccount -UserName USERID1 -Password $pwd -RoleGroups lxc-supervisor,lxc-admin` 
                               -PasswordChangeFirstAccess $true


Related links