Class: Ansible::Ruby::Modules::Net_ping

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/system/net_ping.rb

Overview

Tests reachability using ping from network device to a remote destination. For Windows targets, use the M(win_ping) module instead. For targets running Python, use the M(ping) module instead.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#count ⇒ Integer?

Returns Number of packets to send.

Returns:

  • (Integer, nil) —

    Number of packets to send.



14
 
# File 'lib/ansible/ruby/modules/generated/network/system/net_ping.rb', line 14

attribute :count

#dest ⇒ String

Returns The IP Address or hostname (resolvable by switch) of the remote node.

Returns:

  • (String) —

    The IP Address or hostname (resolvable by switch) of the remote node.



18
 
# File 'lib/ansible/ruby/modules/generated/network/system/net_ping.rb', line 18

attribute :dest

#source ⇒ String?

Returns The source IP Address.

Returns:

  • (String, nil) —

    The source IP Address.



22
 
# File 'lib/ansible/ruby/modules/generated/network/system/net_ping.rb', line 22

attribute :source

#state ⇒ :absent, ...

Returns Determines if the expected result is success or fail.

Returns:

  • (:absent, :present, nil) —

    Determines if the expected result is success or fail.



26
 
# File 'lib/ansible/ruby/modules/generated/network/system/net_ping.rb', line 26

attribute :state

#vrf ⇒ String?

Returns The VRF to use for forwarding.

Returns:

  • (String, nil) —

    The VRF to use for forwarding.



30
 
# File 'lib/ansible/ruby/modules/generated/network/system/net_ping.rb', line 30

attribute :vrf