This cmdlet modifies the properties for an existing user account on the Lenovo XClarity Administrator server.

To modify the password for an existing user account, use the Set-LXCAUserAccountPassword cmdlet.

Note: You cannot pipe objects to this cmdlet.


Set-LXCAUserAccount [-Connection Connection] 
                     -UserAccount UserAccount 
                    [-RoleGroups String[]] 
                    [-State String]
                    [-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.
-UserAccount UserAccount[]
Specifies the user account to be modified. You can use the Get-LXCAUserAccount to obtain a 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-SUPERVISOR. Includes the lxc-supervisor role.

  • LXC-ADMIN. Includes the lxca-admin role.

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

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

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

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

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

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

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

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

-State String
Specifies the current state for the user account. You can specify one of the following values:
  • Active
  • Inactive
-Description String
Specifies a description for the 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 that contains the modified values.


The following example modifies properties for an existing user account.

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

$account = Get-LXCAUserAccount | where { $_.UserName -eq "testuser" }
$newaccount = Set-LXCAUserAccount -UserAccount $account -RoleGroups lxc-security-admin,lxc-admin`
                               -Description "New full name"


Related links