Invoke-VCFCommand¶

Synopsis¶

Connects to the specified SDDC Manager using SSH and invoke SSH commands (SoS).

Syntax¶

Invoke-VCFCommand [[-vcfPassword] <String>] [[-rootPassword] <String>] [-sosOption] <String> [<CommonParameters>]

Description¶

The Invoke-VCFCommand cmdlet connects to the specified SDDC Manager over SSH using the vcf user and subsequently run elevated SOS commands using the root account.

Note

The Invoke-VCFCommand cmdlet requires the POSH-SSH module to be installed.

Examples¶

Example 1¶

Invoke-VCFCommand -vcfpassword VMware1! -rootPassword VMware1! -sosOption general-health

This example will run and display the output of "/opt/vmware/sddc-support/sos --general-health".

Example 2¶

Invoke-VCFCommand -sosOption general-health

This example will ask for vcf and root password to the user and then run and display the output of "/opt/vmware/sddc-support/sos --general-health".

Parameters¶

-vcfPassword¶

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-rootPassword¶

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-sosOption¶

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters¶

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.