Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Ping-NcHost


NAME
Ping-NcHost

SYNOPSIS
Ping an IP address to verify whether the interface is alive.

SYNTAX
Ping-NcHost [-Host] <String> [-Node] <String> [-Count <Int32>] [-WaitSeconds
<Int32>] [-Raw] [-Controller <NcController[]>] [<CommonParameters>]

Ping-NcHost [-Host] <String> -InterfaceOwner <String> -Interface <String> [-
Count <Int32>] [-WaitSeconds <Int32>] [-Raw] [-Controller <NcController[]>]
[<CommonParameters>]


DESCRIPTION
Ping an IP address to verify whether the interface is alive.


PARAMETERS
-Host <String>
The address of the destination.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Node <String>
Specifies the node from which the ping request is to be sent.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Count <Int32>
The number of pings to try before giving up. Default is 20.

Required? false
Position? named
Default value 20
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-WaitSeconds <Int32>
The number of seconds to wait between pings. Default is 1.

Required? false
Position? named
Default value 1
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Raw
Specify to get an unwrapped boolean value.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NcController[]>
A Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-InterfaceOwner <String>
Specifies the name of an interface owner. It may be a node or Vserver n
ame.

Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Interface <String>
Specifies the interface from which the ping request is to be sent.

Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.C.PowerShell.SDK.Cmdlets.Net.PingHostResult


NOTES


Category: net
API: net-cluster-ping
Family: cluster

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

C:\PS>Ping-NcHost -Host 10.61.167.22 -Node Cerebus-03 -Raw


Ping a host by IP address and write the raw boolean to the pipeline.


True


-------------- Example 2 --------------

C:\PS>Get-NcNode | Ping-NcHost 10.61.167.22 -Count 1


Ensure each node can ping a host.


Host Success Node
---- ------- ----
10.61.167.22 True Cerebus-03
10.61.167.22 True Cerebus-04
10.61.167.22 True Cerebus-05
10.61.167.22 True Cerebus-06


-------------- Example 3 --------------

C:\PS>Ping-NcHost -Host 10.61.167.22 -InterfaceOwner Lionetti01 -Interface L
ionetti01_mgmt


Ping a host from a specific interface defined on a vserver.


NcController : cerebus
Host : 10.61.167.22
Success : True
Node :
InterfaceOwner : Lionetti01
Interface : Lionetti01_mgmt



RELATED LINKS
Get-NcNetInterface
Get-NcNode







 Data ONTAP® PowerShell Toolkit