< Back
Get-NsxEdgeStatus
Post
NAME Get-NsxEdgeStatus
SYNOPSIS
Retrieves NSX Edge status
SYNTAX
Get-NsxEdgeStatus [-Edge] <XmlElement> [[-Connection] <PSObject>] [<CommonParameters>]
DESCRIPTION
An NSX Edge Service Gateway provides all NSX Edge services such as firewall,
NAT, DHCP, VPN, load balancing, and high availability.
This cmdlet retrieves NSX Edge Status.
The edgeStatus has the following possible states:
* GREEN: Health checks are successful, status is good.
* YELLOW: Intermittent health check failure. If health check fails for five
consecutive times for all appliances, status will turn RED.
* GREY: unknown status.
* RED: None of the appliances for this NSX Edge are in a serving state.
Get also the status (UP / Down / Applied / Not Configured) of each ESG Service (DNS,
Firewall, Routing, VPN...)
PARAMETERS
-Edge <XmlElement>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? 2
Default value $defaultNSXConnection
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
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Get-NsxEdgeStatus
Get NSX Edge Status
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>((Get-NsxEdge Edge01 | Get-NsxEdgeStatus).featureStatuses.featureStatus | where-object { $_.service -eq
'dns' }).status
Get only status of DNS service
RELATED LINKS
SYNOPSIS
Retrieves NSX Edge status
SYNTAX
Get-NsxEdgeStatus [-Edge] <XmlElement> [[-Connection] <PSObject>] [<CommonParameters>]
DESCRIPTION
An NSX Edge Service Gateway provides all NSX Edge services such as firewall,
NAT, DHCP, VPN, load balancing, and high availability.
This cmdlet retrieves NSX Edge Status.
The edgeStatus has the following possible states:
* GREEN: Health checks are successful, status is good.
* YELLOW: Intermittent health check failure. If health check fails for five
consecutive times for all appliances, status will turn RED.
* GREY: unknown status.
* RED: None of the appliances for this NSX Edge are in a serving state.
Get also the status (UP / Down / Applied / Not Configured) of each ESG Service (DNS,
Firewall, Routing, VPN...)
PARAMETERS
-Edge <XmlElement>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? 2
Default value $defaultNSXConnection
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
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Get-NsxEdgeStatus
Get NSX Edge Status
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>((Get-NsxEdge Edge01 | Get-NsxEdgeStatus).featureStatuses.featureStatus | where-object { $_.service -eq
'dns' }).status
Get only status of DNS service
RELATED LINKS