Skip to main content

Install-LXCAConfigPattern

This cmdlet deploys a server pattern to one or more target servers.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Install-LXCAConfigPattern [-Connection LXCAConnection] 
                           -PatternID String
                           -TargetComputeNodeId String[]
                           -Restart String
                          [-AsJob]
                          [CommonParameter]

Install-LXCAConfigPattern [-Connection LXCAConnection]
                           -PatternID String  
                           -TargetRackServerId String[]
                           -Restart String
                          [-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.
-PatternID String
Specifies the ID of the configuration pattern to be deployed.
-TargetComputeNodeId String[]
Specifies one or more IDs of the target Flex System servers. If a target is an empty bay, specify the location ID; otherwise, specify the server UUID. To obtain the value, use the Get-LXCAConfigPatternDeployableServer cmdlet.
-TargetRackServerId String[]
Specifies one or more UUIDs of target Converged, NeXtScale, and System x servers. The ID is the server location ID. To obtain the value, use the Get-LXCAConfigPatternDeployableServer cmdlet.
-Restart String
Specifies when to restart target server. You can specify one of the following values:
  • Immediate. The server is powered on or restarted immediately, which activates all baseboard management controller, UEFI, and server configuration changes.
  • Defer. Management controller changes are activated on the server immediately. However, UEFI and server configuration changes are not activated until the next restart of the server.

  • Pending. A profile is generated for the server with the settings for review, but the settings are not activated on the server. To activate the settings, you must manually activate the server profile, and restart the server.

-AsJob
If specified, the cmdlet runs as background job and returns a Job object immediately.
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​

If you specify the -AsJob parameter, this cmdlet returns a Job object. The ConfigPatternDeployResult[] can be retrieved from Job.Output.

If you do not specify the -AsJob parameter, this cmdlet returns one or more ConfigPatternDeployResult objects.

Examples​

The following example deploys a server pattern to a target Flex System server and defers the activation of that pattern until the next restart of the server.

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

$patterns = Get-LXCAConfigPattern
$targetchassis = Get-LXCAConfigPatternDeployableServer -PatternId $patterns[0].Id
Install-LXCAConfigPattern -PatternId $patterns[0].Id -TargetComputeNodeId $targetchassis[0].Servers[0].Id`
                          -restart defer

Disconnect-LXCA