PowerCLI Reference

New-HCXSentinelBundle

Synopsis

This cmdlet creates and downloads an HCX Sentinel bundle.

Syntax

New-HCXSentinelBundle -OSType {Windows | Linux} -SGWAppliance <HCXInterconnectAppliance> [-Server <HcxServer[]>] [-Path <String>] [<CommonParameters>]

Related Commands

Detailed Description

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.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
OSTypeOSTypeSpecifies the OS type for which you want to generate the sentinel bundle.trueFalse
PathStringSpecifies the local file path where you can store the downloaded file. If not specified, the current directory is used.falseFalse
ServerHcxServer[]Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.falseFalse
SGWApplianceHCXInterconnectApplianceSpecifies the Sentinel Gateway (SGW) whose bundle is to be generated. You can obtain it from the Interconnect Service Mesh appliance.trueTrue (ByValue)

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXSentinelBundle

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> $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 --------------------------

PS C:\> $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.


Copyright © VMware, Inc. All rights reserved.