Data ONTAP PowerShell Toolkit: Cmdlet Ping-NaFcp

Overview
Categories
Cmdlets
APIs
Provider
Release notes
License
Data ONTAP® PowerShell Toolkit
Switch to Data ONTAP Cluster-mode documentation.
Cmdlet: Ping-NaFcp


NAME
    Ping-NaFcp
    
SYNOPSIS
    Send an ELS ECHO frame to a Fibre Channel address or WWPN.  Returns true if 
    the ping was successful.
    
SYNTAX
    Ping-NaFcp [-FcpAdapter] <String> [-FcpPortId] <UInt32> [[-Payload] <String>
    ] [-Controller <NaController>] [<CommonParameters>]
    
    Ping-NaFcp [-FcpAdapter] <String> [-FcpWwpn] <String> [[-Payload] <String>] 
    [-Controller <NaController>] [<CommonParameters>]
    
    
DESCRIPTION
    Send an ELS ECHO frame to a Fibre Channel address or WWPN.  Returns true if 
    the ping was successful.
    

PARAMETERS
    -FcpAdapter <String>
        Adapter to send the ping request from.
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        Accept wildcard characters?  false
        
    -FcpPortId <UInt32>
        The Fibre Channel address to ping.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Payload <String>
        Additional data to send in the payload of the ELS ECHO frame. The payloa
        d can be up to 255 characters long.
        
        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -Controller <NaController>
        The Data ONTAP controller object, embodied by an NaController object.  T
        his parameter is returned by the Connect-NaController cmdlet.  If not sp
        ecified, the value in the global variable CurrentNaController is used.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        
    -FcpWwpn <String>
        The Fibre Channel WWPN to ping. The format of a WWPN is XX:XX:XX:XX:XX:X
        X:XX:XX where X is a hexadecimal digit.
        
        Required?                    true
        Position?                    2
        Default value                
        Accept pipeline input?       false
        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
    System.Boolean
     
    
NOTES
    
    
        Category: fcp
        API: fcp-ping
    
    --------------  Example 1 --------------
    
    C:\PS>Ping-NaFcp -FcpAdapter 0d -FcpWwpn 50:0a:09:80:87:09:3b:1f
    
    
    Ping WWPN 50:0a:09:80:87:09:3b:1f from FCP adapter 0d.
    
    
    True
    
    
    
RELATED LINKS
    Ping-NaFcpInfo
Data ONTAP® PowerShell Toolkit