Skip to main content

New-LXCADeployTask

This cmdlet creates a task for operating-system deployment, including the target server, OS image profile, target storage device, and networking setting.

The DeployTask object that is returned by this cmdlet can be used by the Install-LXCAOSImage cmdlet.

Note
You cannot pipe objects to this cmdlet.

Syntax​

New-LXCADeployTask [-Connection LXCAConnection] 
                    -ServerUuid String
                    -ImageProfileID String
                   [-ConfigFileID String]
                   [-UnattendedFileID String]
                    -TargetDevice String
                    -MacAddress String
                   [-ADUserName String]
                   [-ADPassword SecureString]
                   [-DNS1 String]
                   [-DNS2 String]
                   [-GateWay String]
                   [-HostName String]
                   [-IpAddress String]
                   [-LicenseKey String]
                   [-Mtu String]
                   [-PrefixLength Int]
                   [-SanID String]
                   [-SubnetMask String]
                   [-VlanId String]
                   [-WindowsDomain String]
                   [-WindowsDomainBlob String]
                   [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.
-ServerUuid String
Specifies the UUID of the target server for operating-system deployment. The target server can be retrieved using theGet-LXCADeployableServer cmdlet.
-ImageProfileID String
Specifies the OS image profile ID. The profile ID can be retrieved using theGet-LXCAOSImage cmdlet.
-ConfigFileID String
ID of the custom configuration-settings file to use for this OS deployment.

This parameter is required if the OS image profile (that is specify by the ImageProfileID parameter) includes a custom configuration-settings file; otherwise, this parameter is ignored.

-UnattendedFileID String
ID of the unattended file to use for this OS deployment.

This parameter is required if OS image profile (that is specify by the ImageProfileID parameter) includes a custom unattended file; otherwise, this parameter is ignored.

-TargetDevice String
Specifies the location on target server where the OS image is to be deployed. You can specify one of the following values:
  • LocalDisk. Uses the local disk drive.
  • EmbeddedHypervisor. Uses embedded hypervisor (USB or SD media adapter) when ESXi is selected.
    Note
    For XClarity Administrator v1.0, use usbdisk instead of EmbeddedHypervisor for a USB Embedded Hypervisor when ESXi is selected.
  • M.2drive. Uses first enumerated M.2 drive in the managed server.
  • SanDisk. Uses SAN volumes if available. If specified, you must also specify the -SanID parameter.
-MacAddress String
Specifies the MAC address of the host server to which the IP address is to be bound.

For XClarity Administrator v1.2.0 and later, you can also specify AUTO to automatically detect the first Ethernet port that can be configured and used for deployment automatically.

-ADUserName String
Specifies the Active Directory user name that is required to join a domain.
-ADPassword SecureString
Specifies the Active Directory password that is required to join a domain.
-LicenseKey String
Specifies the license key that is needed for Windows and ESXi operating-system installation.
-DNS1 String
Specifies the first DNS server, in IPv4 format, on the network to be used after operating-system deployment. This is required if a static IP address was chosen when the global settings were defined.
-DNS2 String
Specifies the secondary DNS server, in IPv4 format, on the network to be used after operating system deployment. This is required if a static IP address was chosen when the global settings were defined.
-GateWay String
Specifies the gateway, in IPv4 format, of the network to be used after operating system deployment. This is required if a static IP address was chosen when the global settings were defined.
-HostName String
Specifies the hostname for the host server. If a hostname is not specified, a default hostname is assigned.
-IpAddress String
Specifies the IP address of the host server, in IPv4 format, to be used after operating-system deployment. This is required if a static IP address was chosen when the global settings were defined.
-Mtu Int
Specifies the maximum transmission unit (MTU) of the network to be used after operating system deployment. The default value is 1500. This is required if a static IP address was chosen when the global settings were defined.
-PrefixLength Int
Specifies the IPv6 prefix length to be used after operating-system deployment. This is required if a static IPv6 was chosen when the global settings were defined.
-SanID String
Specifies the SAN ID. This is required if the target device is a SAN disk. The SAN ID is a string starting with lunpluswwn=, for example, lunpluswwn=2@50:05:07:68:05:0c:09:bb, where 2 is the LUN and 50:05:07:68:05:0c:09:bb is the WWN. Ensure that you use @ to join the two strings.
-SubnetMask String
Specifies the subnet mask, in IPv4 format, of the network to be used after operating-system deployment. This is required if a static IP address was chosen when the global settings were defined.
-VlanId String
Specifies the VLAN ID for operating-system VLAN tagging.
Important
This parameter requires that the VLAN mode setting is enabled in the global settings for operating-system deployment. To change the global settings, use the Set-LXCADeployGlobalSetting cmdlet.
-WindowsDomain String
(Windows only) Specifies the domain that the operating system is to join after it is installed successfully. If there is an organizational unit (OU), the domain must be a string like domain/ou.

If the operating system will not join a domain, you can set this field to null.

Note

  • Use the ADUserName and ADPassword parameters to specify the user name and password for the domain.

  • To join an Active Directory domain, you must specify either the WindowsDomain or WindowsDomainBlob parameter. If both are specified, the WindowsDomainBlob parameter is used.

-WindowsDomainBlob String
(Windows only) Specifies the Active Directory Computer Account Metadata (in Base-64 encoded blob format) that can be used to join the Active Directory domain. For instructions for generating a file that contains the metadata blob data, see Integrating with Windows Active Directory.
Note

  • To join an Active Directory domain, you must specify either the WindowsDomain or WindowsDomainBlob parameter. If both are specified, the WindowsDomainBlob parameter is used.

  • You can use metadata blob data when deploying any Windows operating system. However, this method must be used for Windows Nano Server. Specifying a domain in global settings is not supported for Windows Nano 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​

This cmdlet returns a DeployTask object that contains all information for operating-system deployment. The task can be used by Install-LXCAOSImage cmdlet.

Examples​

The following example creates a deployment task and deploys an operating-system image.

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

$nodes = Get-LXCADeployableServer
$images = Get-LXCAOSImage | where {$_.Name -contains "esxi5.5"}
$deployTask = New-LXCADeployTask -ServerUuid $nodes[0].Uuid -ImageProfileID $images[0].Profiles[0].Id`
                                 -TargetDevice "SanDisk" -SanId "WWN123445" -IpAddress 9.5.12.122`
                                 -HostName "Server1" -MacAddress $nodes[0].MacAddresses[0]`
                                 -SubnetMask 255.255.255.0 -GateWay 9.5.12.1 -DNS1 9.10.244.100`
                                 -DNS2 9.10.244.200 -Mtu 1500
Install-LXCAOSImage -DeployTask $deploytask

Disconnect-LXCA