Skip to main content

Install-LXCAConfigProfile

This cmdlet deploys a server profile to a specific server.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Install-LXCAConfigProfile [-Connection LXCAConnection] 
                           -ProfileID String
                           -TargetComputeNodeId String[]
                           -Restart String
                          [-AsJob]
                          [CommonParameter]

Install-LXCAConfigProfile [-Connection LXCAConnection]
                           -ProfileID 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.
-ProfileID String
Specifies the ID of the configuration profile to be deployed.
-TargetComputeNodeId String
Specifies a target Flex System compute node ID. 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 a target Converged, NeXtScale, or System x server UUID. The ID is the server location ID. To obtain the value, use theGet-LXCAConfigPatternDeployableServer cmdlet.
-Restart String
Specifies when to restart the 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.
-AsJob
When 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 objects can be retrieved from Job.Output.

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

Examples​

The following example retrieves a server profile from one server and deploys it to another server.

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

$profile = Get-LXCAConfigProfile | where {$_.ServerUuid -ieq AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA}
Remove-LXCAConfigProfileFromSystem -Profile $profile
Install-LXCAConfigProfile -ProfileId $profile.Id -TargetComputeNodeId BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB`
                          -restart defer

Disconnect-LXCA