Add-LXCOManager

Syntax​

Add-LXCOManager [-Connection LXCOConnection]
                  -ManagerType String
                  -Credential PSCredential
                 [-Port Integer]
                  -ManagerIP String
                 [-EnableDriveAnalyticsData]
                 [-AuthSource String]
                 [CommonParameter]

Add-LXCOManager [-Connection LXCOConnection]
                  -ManagerType String
                  -APIKey String
                  -ResourceName String
                 [-EcoStruxurePortalUrl String]
                 [CommonParameter]

Parameters​

-Connection LXCAConnection

Specifies the connection to the Lenovo XClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.

-ManagerType String

Specifies the type of resource manager. This can be one of the following values.

• SchneiderEcoStruxureIT. Schneider Electric EcoStruxure IT Expert
• vRealizeOperationsManager. vRealize Operations Manager
• XClarityAdministrator. Lenovo XClarity Administrator

-Credential PSCredential

Specifies a credential object required to authenticate on to the manager.

Note

This parameter is used only by XClarity Administrator and vRealize Operations Manager, and is ignored for all other managers

-Port Integer

Specifies the resource manager port.

Note

This parameter is used only by XClarity Administrator and vRealize Operations Manager, and is ignored for all other managers

-ManagerIP String

Specifies the resource manager host name or IP address.

Note

This parameter is used only by XClarity Administrator and vRealize Operations Manager, and is ignored for all other managers

-EnableDriveAnalyticsData

If specified, drive analytics data collection is enabled.

Note

This parameter is used only by XClarity Administrator and is ignored for all other managers

-AuthSource String

Specifies the name of the authentication source for users and groups.

Note

This parameter is used only by vRealize Operations Manager and is ignored for all other managers

-APIKey String

Specifies the public API key for authentication on a EcoStruxure IT Expert.

Note

This parameter is used only for EcoStruxure IT Expert. Otherwise, the Lenovo.XClarityOrchestrator.PowerShell.Common.LXCOException is thrown.

-ResourceName String

Specifies the name assigned to this resource manager.

Note

This parameter is used only for EcoStruxure IT Expert. Otherwise, the Lenovo.XClarityOrchestrator.PowerShell.Common.LXCOException is thrown.

-EcoStruxurePortalUrl String

Specifies the custom URL to access EcoStruxure IT Expert portal.

Note

This parameter is used only for EcoStruxure IT Expert. Otherwise, the Lenovo.XClarityOrchestrator.PowerShell.Common.LXCOException is thrown.

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​

• Lenovo.XClarityOrchestrator.PowerShell.Data.LXCOJob

  If the request was accepted the orchestrator server, this cmdlet returns an LXCOJob object that contains the status of the register request.

• Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage

  If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.

Examples​

The following example registers an EcoStruxure IT Expert resource manager.

$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck

$apiKey = "AK1/2sixskmmc06wj/1i6v3epcz5c25rc29jv1t00hce1pjahyobux63"
$portalUrl = https://api.ecostruxureit.com/rest/v1/organizations
$result = Add-LXCOManager -APIKey $apiKey `
                           -ManagerType SchneiderEcoStruxureIT `
                           -ResourceName "My EcoStruxure" `
                           -EcoStruxurePortalUrl $portalUrl

Disconnect-LXCO

The following example registers an XClarity Administrator resource manager.

$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck

$managerIp = "192.0.2.123"
$managerCred = Get-Credential
$result = Add-LXCOManager -Credential $managerCred `
                           -ManagerIP $managerIp `
                           -ManagerType XClarityAdministrator `
                           -EnableDriveAnalyticsData

Disconnect-LXCO