New-HCXSentinelBundle Command | Vmware PowerCLI Reference

New-HCXSentinelBundle

This cmdlet creates and downloads an HCX Sentinel bundle. You need to install the Sentinel agent software on all virtual machines that you want to migrate by using the OS Assisted Migration service.

Syntax

New-HCXSentinelBundle
-OSType < OSType >
-SGWAppliance < HCXInterconnectAppliance >
[-Path < String > ]
[-ProgressAction < ActionPreference > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
OSType OSType named
Specifies the OS type for which you want to generate the sentinel bundle.
required
SGWAppliance HCXInterconnectAppliance named
  • pipeline
Specifies the Sentinel Gateway (SGW) whose bundle is to be generated. You can obtain it from the Interconnect Service Mesh appliance.
optional Path String named
Specifies the local file path where you can store the downloaded file. If not specified, the current directory is used.
optional ProgressAction ActionPreference named
optional Server HcxServer[] named
Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.

Output

System.IO.FileInfo

Examples

Example 1

$sgwAppliance = Get-HCXAppliance -Type SentinelGateway
$fileInfo = New-HCXSentinelBundle -OSType Linux -SGWAppliance $sgwAppliance

Creates a sentinel bundle for the specified OS and downloads it in the current directory.

Example 2

$sgwAppliance = Get-HCXAppliance -Type SentinelGateway
$fileInfo = New-HCXSentinelBundle -OSType Windows -SGWAppliance $sgwAppliance -Path "C:\\Documents\\sentinel-bundle.zip"

Creates a sentinel bundle for the specified OS and downloads it in the specified location.

Related Commands

HCXSentinel

This cmdlet uninstalls the sentinel from a virtual machine.

This cmdlet upgrades the HCX sentinel software running on the source virtual machine.

HCXSentinelBundle

This cmdlet creates and downloads an HCX Sentinel bundle.