Use-LXCOServerConfigPattern
This cmdlet creates a job to deploy a server configuration pattern to one or more servers. When the pattern is deployed, Lenovo XClarity Orchestrator modifies the settings on each server to match the settings in the assigned server-configuration pattern.
Note
You cannot pipe objects to this cmdlet.
Syntax
Use-LXCOServerConfigPattern [-Connection LXCOConnection]
-DeviceUUID String[]
-ActivationRule String
[CommonParameter]
Use-LXCOServerConfigPattern [-Connection LXCOConnection]
-Groups String[]
-ActivationRule String
[CommonParameter]
Use-LXCOServerConfigPattern [-Connection LXCOConnection]
-AllServers
-ActivationRule String
[CommonParameter]
Parameters
- -Connection LXCOConnection
- Specifies the connection to the Lenovo XClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.
- -Groups String[]
- Specifies a list of IDs of device groups, separated by a comma.
- -DeviceUUIDs String[]
- Specifies a list of UUIDs of devices, separated by a comma.
- -AllServers
- If specified, the configuration pattern is deployed to all managed servers.
- -ActivationRule String
- Specifies when to activate the configuration. This can be one of the following values.
- DeferredActivation. (default) Activates management-controller settings but do not restart the server. UEFI settings are activated after the next restart of the server.
- 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.LXCOJobFullData
If the request was accepted the orchestrator server, this cmdlet returns an LXCOJobFullData object that contains the status of the operation that is associated with this request. If available, job logs are added to the root job and subtasks.
- 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 deploys the assigned configuration pattern to all devices in a specific group.
$cred = Get-Credential
Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred –SkipCertificateCheck
$result = Use-LXCOServerConfigPattern -Groups 40EA1D96BCB5B70137D0EDF9DD4B20F9 `
-ActivationRule DeferredActivation
Disconnect-LXCO
The following example deploys assigned pattern to specific managed devices.
$cred = Get-Credential
Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred –SkipCertificateCheck
$result = Use-LXCOServerConfigPattern `
-DeviceUUIDs 00632D78DE644E23B712E200FE449787,349D0AD7A3AF11EA9F5F994620EB76C6 `
-ActivationRule DeferredActivation
Disconnect-LXCO
The following example deploys assigned pattern to all managed devices.
$cred = Get-Credential
Connect-LXCO -HostUri "192.0.2.0" -Credential $Cred –SkipCertificateCheck
$result = Use-LXCOServerConfigPattern -AllServers $result`
-ActivationRule DeferredActivation
Disconnect-LXCO
Give documentation feedback