< Back
Invoke-NsxCli
Post
NAME Invoke-NsxCli
SYNOPSIS
Provides access to the NSX Centralised CLI.
SYNTAX
Invoke-NsxCli [-Query] <String> [-SupressWarning] [-Connection <PSObject>] [-RawOutput] [<CommonParameters>]
DESCRIPTION
The NSX Centralised CLI is a feature first introduced in NSX 6.2. It
provides centralised means of performing read only operations against
various aspects of the dataplane including Logical Switching, Logical
Routing, Distributed Firewall and Edge Services Gateways.
The results returned by the Centralised CLI are actual (realised) state
as opposed to configured state. They should you how the dataplane actually
is configured at the time the query is run.
WARNING: The Centralised CLI is primarily a trouble shooting tool and
it and the PowerNSX cmdlets that expose it should not be used for any other
purpose. All the PowerNSX cmdlets that expose the central cli rely on a
bespoke text parser to interpret the results as powershell objects, and have
not been extensively tested.
PARAMETERS
-Query <String>
string text of Central CLI command to execute
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SupressWarning [<SwitchParameter>]
Switch parameter to ignore the experimental warning
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
Proper NSX connection [PSCustomObject]
Required? false
Position? named
Default value $defaultNSXConnection
Accept pipeline input? false
Accept wildcard characters? false
-RawOutput [<SwitchParameter>]
Switch parameter that will not try to parse the output
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
RELATED LINKS
SYNOPSIS
Provides access to the NSX Centralised CLI.
SYNTAX
Invoke-NsxCli [-Query] <String> [-SupressWarning] [-Connection <PSObject>] [-RawOutput] [<CommonParameters>]
DESCRIPTION
The NSX Centralised CLI is a feature first introduced in NSX 6.2. It
provides centralised means of performing read only operations against
various aspects of the dataplane including Logical Switching, Logical
Routing, Distributed Firewall and Edge Services Gateways.
The results returned by the Centralised CLI are actual (realised) state
as opposed to configured state. They should you how the dataplane actually
is configured at the time the query is run.
WARNING: The Centralised CLI is primarily a trouble shooting tool and
it and the PowerNSX cmdlets that expose it should not be used for any other
purpose. All the PowerNSX cmdlets that expose the central cli rely on a
bespoke text parser to interpret the results as powershell objects, and have
not been extensively tested.
PARAMETERS
-Query <String>
string text of Central CLI command to execute
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SupressWarning [<SwitchParameter>]
Switch parameter to ignore the experimental warning
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
Proper NSX connection [PSCustomObject]
Required? false
Position? named
Default value $defaultNSXConnection
Accept pipeline input? false
Accept wildcard characters? false
-RawOutput [<SwitchParameter>]
Switch parameter that will not try to parse the output
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
RELATED LINKS