Skip to main content

Add-LXCAManagedDevice

This cmdlet adds one or more chassis, rack and tower servers, RackSwitch switches, and rack storage devices for management by the Lenovo XClarity Administrator server (manages a device).

This cmdlet does not support managing RackSwitch switches by specifying a UUID; however, you can specify an IP address.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Add-LXCAManagedDevice [-Connection LXCAConnection] 
                       -ChassisUuid String[] 
                       -Username String-Password SecureString | -StoredCredentialId String
                      [-RecoveryPassword SecureString]
                       -DisableManagedAuth
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice [-Connection LXCAConnection] 
                       -RackServerUuid String[] 
                       -Username String-Password SecureString | -StoredCredentialId String
                       -RecoveryPassword SecureString
                       -DisableManagedAuth
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice [-Connection LXCAConnection] 
                       -ThinkServerUuid String[] 
                       -Username String-Password SecureString | -StoredCredentialId String
                       -DisableManagedAuth
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice [-Connection LXCAConnection]
                       -StorageUuid String[] 
                       -Username String-Password SecureString | -StoredCredentialId String
                       -DisableManagedAuth
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice [-Connection LXCAConnection] 
                       -IPAddress String[] 
                       -Username String-Password SecureString | -StoredCredentialId String
                      [-RecoveryPassword SecureString]
                       -DisableManagedAuth
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice [-Connection LXCAConnection]
                       -FQDN  String[] 
                       -Username String-Password SecureString | -StoredCredentialId String
                      [-RecoveryPassword SecureString]
                       -DisableManagedAuth
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice [-Connection LXCAConnection] 
                       -IPv4Range String[] 
                       -Username String-Password SecureString | -StoredCredentialId String
                      [-RecoveryPassword SecureString]
                       -DisableManagedAuth
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice LXCAConnection
                       -ServerAddress String
                       -UserName String
                      [-ApplicationId String]
                      [-Folder String]
                      [-Safe String]
                      [-DisableManagedAuth]
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice LXCAConnection
                      -DeviceAddress String
                      -DeviceType  String
                      -DisableDeviceDiscovery
                      -StoredCredentialId  String
                      [-ForceManage]
                      [-AsJob]
                      [CommonParameter]

Add-LXCAManagedDevice [-Connection LXCAConnection] 
                       -BulkImportFile String 
                       -DisableManagedAuth
                       -ServerStoredCredentialsId String
                      [-CurrentRackServerUsername String]
                      [-CurrentRackServerPassword SecureString]
                      [-NewRackServerPassword SecureString]
                       -ChassisStoredCredentialsId  String
                      [-CurrentChassisUsername String]
                      [-CurrentChassisPassword SecureString] 
                      [-NewChassisPassword SecureString] 
                      [-RecoveryPassword SecureString]
                      [-CurrentStorageUserName  SecureString]
                      [-CurrentStoragePassword  SecureString]
                      [-CurrentSwitchUserName  SecureString]
                      [-CurrentSwitchPassword  SecureString]
                      [-SwitchEnablePassword  SecureString]
                      [-AsJob]
                      [CommonParameter]

Parameters​

-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.
-DeviceAddress String
Specifies the IP address of the device to manage.
-DeviceType String
Specifies the type of device to manage. This can be the following value.
  • ThinkSystemDBSwitch
  • NVIDIAMellanoxSwitch
-DisableDeviceDiscovery
If specified, devices are managed using the specified IP address without first discovering the device.
-ChassisUuid String[]
Specifies one or more UUIDs of chassis to be managed by the XClarity Administrator server. The chassis must have already been discovered.
Tip
Use the Get-LXCAThinkServerChassis -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed chassis.
-RackServerUuid String[]
Specifies one or more UUIDs of Converged, NeXtScale, and System x servers to be managed by the XClarity Administrator server. The servers must have already been discovered.
Tip
Use the Get-LXCARackServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed Converged, NeXtScale, and System x servers.
-ThinkServerUuid String[]
Specifies one or more UUIDs of ThinkServer servers to be managed by the XClarity Administrator server. The servers must have already been discovered.
Tip
Use the Get-LXCAThinkServer -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed ThinkServer servers.
-StorageUuid String[]
Specifies one or more UUIDs for rack storage devices to be managed by the XClarity Administrator server. The storage device must have already been discovered.
Tip
Use the Get-LXCAStroage -Unmanaged cmdlet to retrieve the UUIDs of discovered but not managed storage devices.
-FQDN String[]
Specifies one or more FQDN addresses of chassis, rack servers and rack storage devices to be managed by the XClarity Administrator server.
-IPAddress String[]
Specifies one or more IPv4 and IPv6 addresses for chassis, rack and tower servers, and rack storage devices , and RackSwitch switches to be managed by the XClarity Administrator server.
-IPv4Range String[]
Specifies one or more ranges of IPv4 addresses. Use a format similar to 192.168.9.1-192.168.9.10 to specify a range.
-StoredCredentialId String
Specifies the stored credential to use for this managed device.

Use theGet-LXCAStoredCredential cmdlet to retrieve stored credential ID.

If you specify -DisableManageAuth, you must specify a stored credential to manage the device; otherwise, you must specify either -Username or --StoredCredentialId, but not both.

-Username String
Specifies a user account with lxc-supervisor authority. If the device to be managed is a chassis, specify a user account for the CMM in that chassis.

You must specify either -Username or --StoredCredentialId, but not both.

-Password SecureString
Specifies the password for the user account.
-RecoveryPassword SecureString
Specifies the recovery-ID password for the device.

When you manage a chassis, the CMM is configured to authenticate users with XClarity Administrator. Local CMM user accounts are no longer valid. If there are issues with XClarity Administrator, you can use the RECOVERY_ID to access the CMM directly. Ensure that you write down the password that you specify and store it in a secure location.

When you manage a Converged, NeXtScale, or System x server, the baseboard management controller is configured to authenticate users with the XClarity Administrator server. Local management-controller user accounts are no longer valid. If there are issues with the XClarity Administrator server, you can use the RECOVERY_ID to access the management controller directly. Ensure that you write down the password that you specify and store it in a secure location.

-BulkImportFile String
Specifies the path of the bulk-import file to use to manage multiple devices. The file template in CSV format can be downloaded from the XClarity Administrator web interface.
-ServerStoredCredentialsId String
Specifies the stored credentials for all servers if you specify the -BulkImportFile parameter.
-CurrentRackServerUsername String
Specifies the user account for the rack server if you specify the -BulkImportFile parameter. This name is used if a user name is not defined in the bulk-import file.
-CurrentRackServerPassword SecureString
Specifies the password for the user account that is specified using the -CurrentRackServerUsername parameter. This password is used if a password is not defined in the bulk-import file.
-NewRackServerPassword SecureString
Specifies the new password for the user account that is specified using the -CurrentRackServerUsername parameter. This password is used only if the current password is expired.
-ChassisStoredCredentialsId String
Specifies the stored credentials for all chassis and chassis devices if you specify the -BulkImportFile parameter.
-CurrentChassisUsername String
Specifies the user account for the chassis if you specify the -BulkImportFile parameter. This name is used if there a user name is not defined in the bulk-import file.
-CurrentChassisPassword SecureString
Specifies the password for the user account that is specified using the -CurrentChassisUsername parameter. This password is used if a password is not defined in the bulk-import file.
-NewChassisPassword String
Specifies the new password for the user account that is specified using the -CurrentChassisUsername parameter. This password is used only if the current password is expired.
-CurrentStorageUserName String
Specifies the user account for the storage device if you specify the -BulkImportFile parameter. This name is used if a user name is not defined in the bulk-import file.
-CurrentStoragePassword SecureString
Specifies the password for the user account that is specified using the -CurrentStorageUserName parameter. This password is used if a password is not defined in the bulk-import file.
-CurrentSwitchUserName String
Specifies the user account for the RackSwitch switch if you specify the -BulkImportFile parameter. This name is used if a user name is not defined in the bulk-import file.
-CurrentSwitchPassword SecureString
Specifies the password for the user account that is specified using the -CurrentSwitchUserName parameter. This password is used if a password is not defined in the bulk-import file.
-SwitchEnablePassword SecureString
Specifies the password to enable Privileged Exec Mode, if the switch requires it. This password is used if a password is not defined in the bulk-import file.
-ServerAddress String
Specifies the IP address or hostname where the user account is stored, as defined in CyberArk. This is typically the IP address of the Lenovo XClarity Controller or external LDAP server (if applicable).
-UserName String
Specifies the name of the user account to use to access the device.
-ApplicationId String
Specifies the application ID from CyberArk
Note

  • If you specify the -ApplicationId, you must also specify -Safe and -Folder.

  • If you do not specify -ApplicationId, XClarity Administrator uses the paths that are already defined to identify the onboarded accounts in CyberArk.

-Folder String
Specifies the folder from CyberArk.
Note

  • If you specify the -ApplicationId, you must also specify -Safe and -Folder.

  • If the onboarded account is not in a Folder, specify an empty string.

-Safe String
Specifies the safe from CyberArk.
Note
If you specify the -ApplicationId, you must also specify -Safe and -Folder.
-DisableManagedAuth
If specified, devices are managed using local authentication. If not specified, devices are managed using XClarity Administrator managed authentication.
Note
Managed and local authentication are not supported for ThinkServer and System x M4 servers.
-ForceManage
If specified, the devices are force managed by this XClarity Administrator server.
Note
Use this force-management option only if you previously attempted to manage the device and management was not successful due to one of the following error conditions.

  • If the managing XClarity Administrator failed and cannot be recovered.

    Note
    If the replacement XClarity Administrator instance uses the same IP address as the failed XClarity Administrator, you can manage the device again using the RECOVERY_ID account and password (if applicable) and the Force management option.

  • If the managing XClarity Administrator was taken down before the devices were unmanaged.

  • If the devices were not unmanaged successfully.

Attention
Devices can be managed by only one XClarity Administrator instance at a time. Management by multiple XClarity Administrator instances is not supported. If a device is managed by one XClarity Administrator, and you want to manage it with another XClarity Administrator, you must first unmanage the device from the original XClarity Administrator, and then manage it with the new XClarity Administrator.
-AsJob
When specified, the cmdlet runs as background job, and returns a Job object immediately. If not specified, the cmdlets runs in synchronous mode.
CommonParameters
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.

Results​

This cmdlets returns one of the following objects:
  • If the -AsJob parameter is specified, a Job object is returned.
  • If no UUID is specified, a ManagedDeviceResult object is returned.
  • If the -ChassisUUID is specified, a ChassisManageResult object is returned.
  • If the -RackServerUUID is specified, a RackServerManageResult object is returned.
  • If the -ThinkServerUUID is specified, a ThinkServerManageResult object is returned.
  • If the -StorageUUID parameter is specified, a StroageManageResult object is returned.

Examples​

  • The following example manages a Brocade switch without first discovering the device.
    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred

    $job = Add-LXCAManagedDevice -DeviceAddress 192.0.2.125 -DeviceType ThinkSystemDBSwitch`
                                 -DisableDeviceDiscovery -StoredCredentialId 11524 -AsJob -ForceManage
    while($job.State -eq "Running")
    {
       Start-Sleep -Seconds 5
    }

    Disconnect-LXCA
  • The following example retrieves all chassis that have been discovered but that are currently unmanaged and then manages those chassis using managed authentication.
    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred

    $unmanagedchassis = Get-LXCAChassis -Unmanaged
    $password = ConvertTo-SecureString "Password" -AsPlainText Force
    $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText Force
    foreach ($chassis in $unmanagedchassis)
    {
        Add-LXCAManagedDevice -ChassisUuid $chassis.uuid -Username ADMIN  -Password $password` 
                              -RecoveryPassword $recoveryPwd
    }

    Disconnect-LXCA
  • The following example retrieves all chassis that have been discovered but that are currently unmanaged and then manages those chassis using local authentication.
    $cred = Get-Credential
    Connect-LXCA -Host192.0.2.0 -Credential $cred

    $unmanagedchassis = Get-LXCAChassis -Unmanaged
    $password = ConvertTo-SecureString "Password" -AsPlainText Force
    $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText Force
    foreach ($chassis in $unmanagedchassis)
    {
        Add-LXCAManagedDevice -ChassisUuid $chassis.uuid -StoredCredentialId $SCId -DisableManagedAuth
    }

    Disconnect-LXCA

  • The following example manages an undiscovered chassis as a job that runs in the background.

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

    $password = ConvertTo-SecureString "Password" -AsPlainText -Force
    $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText -Force
    $job = Add-LXCAManagedDevice -IpAddress 1.111.11.11 -Username USERID -Password $password`
                                 -RecoveryPassword $recoveryPwd -AsJob
    while($job.State -eq "Running") 
    {
        Start-Sleep -Seconds 5 
    }

    Disconnect-LXCA

  • The following example manages multiple devices using an IPv4 address range.

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

    $password = ConvertTo-SecureString "Password" -AsPlainText -Force
    $recoveryPwd = ConvertTo-SecureString "Password2" -AsPlainText -Force
    Add-LXCAManagedDevice -Ipv4Range 1.111.11.11-1.111.11.20 -Username USERID -Password $password`
                          -RecoveryPassword $recoveryPwd

    Disconnect-LXCA

  • The following example uses a bulk-import file to manage multiple devices using a user name and password and managed authentication.

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

    $password = ConvertTo-SecureString "Password" -AsPlainText -Force
    Add-LXCAManagedDevice -BulkImportFile c:\buikimport.csv -CurrentRackServerUsername USERID`
                          -CurrentRackServerPassword $password

    Disconnect-LXCA
  • The following example uses a bulk-import file to manage multiple devices using a stored credential and local authentication.
    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred

    $password = ConvertTo-SecureString "Password" -AsPlainText -Force
    Add-LXCAManagedDevice -BulkImportFile c:\buikimport.csv -ServerStoredCredentialsId $scId -DisableManagedAuth

    Disconnect-LXCA
  • The following example discovers and manages a server when managed authentication is enabled and uses CyberArk for authentication.
    $cred = Get-Credential
    Connect-LXCA -Host 192.0.2.0 -Credential $cred

    $job = Add-LXCAManagedDevice -ServerAddress 192.0.2.125 `
                                 -UserName UserName -ForceManage -AsJob 

    while($job.State -eq "Running") 
    {
        Start-Sleep -Seconds 5 
    }

    Disconnect-LXCA

Remove-LXCAManagedDevice