Class: IControl::Networking::ISessionPeerDiscovery

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/networking/i_session_peer_discovery.rb,
lib/icontrol/networking.rb

Overview

The Dynamic Peer Discovery interface enables you to work with the definitions and attributes contained in a device’s peer discovery objects.

Defined Under Namespace

Classes: DiscoveryMode, DiscoveryModeSequence, FilterMode, FilterModeSequence

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#discoverable_peer_enabled_state ⇒ EnabledState

Gets the setting allows other remote endpoints to discover this local endpoint and advertises the local ability to connect.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



22
23
24
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 22

def discoverable_peer_enabled_state
  super
end

#discovered_peer_enabled_state ⇒ EnabledState

Gets the current setting allows other remote endpoints to discover this local endpoint and enables and disables the logic that detects this condition.

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



34
35
36
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 34

def discovered_peer_enabled_state
  super
end

#discovery_mode ⇒ DiscoveryMode

Gets the modes that allows other remote endpoints to enable automatic discovery of this local iSession endpoint

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



46
47
48
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 46

def discovery_mode
  super
end

#discovery_mode_enabled_state ⇒ FilterMode

Gets the setting that allows other remote endpoints to enable automatic discovery of this local iSession endpoint

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



58
59
60
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 58

def discovery_mode_enabled_state
  super
end

#icmp_backoff_time ⇒ short

Gets the setting that controls the time we allow for ICMP retries for other remote endpoints to discover this local endpoint

Returns:

  • (short)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



70
71
72
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 70

def icmp_backoff_time
  super
end

#icmp_max_requests ⇒ short

Gets the setting that controls the number of ICMP requests that we alow for other remote endpoints to discover this local endpoint

Returns:

  • (short)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



82
83
84
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 82

def icmp_max_requests
  super
end

#icmp_max_retries ⇒ short

Gets the setting that controls the number of ICMP retries that we allow for other remote endpoints to discover this local endpoint

Returns:

  • (short)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



94
95
96
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 94

def icmp_max_retries
  super
end

#list ⇒ long

Gets a list of all Dynamic Peer Discovery objects on this device.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



105
106
107
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 105

def list
  super
end

#max_peer_count ⇒ short

Gets the setting that controls the number of ICMP requests that we alow for other remote endpoints to discover this local endpoint

Returns:

  • (short)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



117
118
119
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 117

def max_peer_count
  super
end

#set_discoverable_peer_enabled_state(opts) ⇒ Object

Sets the setting allows other remote endpoints to discover this local endpoint and advertises the local ability to connect.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



138
139
140
141
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 138

def set_discoverable_peer_enabled_state(opts)
  opts = check_params(opts,[:discoverable_peer])
  super(opts)
end

#set_discovered_peer_enabled_state(opts) ⇒ Object

Resets the current setting that allows other remote endpoints to discover this local endpoint and enables and disables the logic that detects this condition.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



152
153
154
155
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 152

def set_discovered_peer_enabled_state(opts)
  opts = check_params(opts,[:discover_peer])
  super(opts)
end

#set_discovery_mode(opts) ⇒ Object

Sets the modes that allows other remote endpoints to enable automatic discovery of this local iSession endpoint

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :discovery_modes (IControl::Networking::iSessionPeerDiscovery::DiscoveryMode) —

    The discovery mode setting.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



166
167
168
169
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 166

def set_discovery_mode(opts)
  opts = check_params(opts,[:discovery_modes])
  super(opts)
end

#set_discovery_mode_enabled_state(opts) ⇒ Object

Sets the setting that allows other remote endpoints to enable automatic discovery of this local iSession endpoint

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :discovery_mode (IControl::Networking::iSessionPeerDiscovery::FilterMode) —

    The discovery mode setting.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



180
181
182
183
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 180

def set_discovery_mode_enabled_state(opts)
  opts = check_params(opts,[:discovery_mode])
  super(opts)
end

#set_icmp_backoff_time(opts) ⇒ Object

Sets the setting that controls the time we allow for ICMP retries for other remote endpoints to discover this local endpoint

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :max_backoff_time (short) —

    The max icmp backoff time of the Dynamic Peer Discovery objects.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



194
195
196
197
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 194

def set_icmp_backoff_time(opts)
  opts = check_params(opts,[:max_backoff_time])
  super(opts)
end

#set_icmp_max_requests(opts) ⇒ Object

Sets the setting that controls the number of ICMP requests that we alow for other remote endpoints to discover this local endpoint

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :max_requests (short) —

    The max number of requests.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



208
209
210
211
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 208

def set_icmp_max_requests(opts)
  opts = check_params(opts,[:max_requests])
  super(opts)
end

#set_icmp_max_retries(opts) ⇒ Object

Sets the setting that controls the number of ICMP retries that we allow for other remote endpoints to discover this local endpoint

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :max_retries (short) —

    The number of retries.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



222
223
224
225
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 222

def set_icmp_max_retries(opts)
  opts = check_params(opts,[:max_retries])
  super(opts)
end

#set_max_peer_count(opts) ⇒ Object

Sets the setting that controls the number of ICMP requests that we alow for other remote endpoints to discover this local endpoint

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :max_peers (short) —

    The max number of peers.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



236
237
238
239
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 236

def set_max_peer_count(opts)
  opts = check_params(opts,[:max_peers])
  super(opts)
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


125
126
127
 
# File 'lib/icontrol/networking/i_session_peer_discovery.rb', line 125

def version
  super
end