Class: IControl::Networking::Trunk

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

Overview

The Trunk interface enables you to work with the definitions and attributes contained in a device's trunk.

Defined Under Namespace

Classes: DistributionHashOption, DistributionHashOptionSequence, LACPTimeoutOption, LACPTimeoutOptionSequence, LinkSelectionPolicy, LinkSelectionPolicySequence, TrunkStatisticEntry, TrunkStatisticEntrySequence, TrunkStatistics

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

- (EnabledState) active_lacp_state

Gets the states indicating whether LACP is operating in active or passive mode. When operating in passive mode, LACP will not send LACP frames out LACP-enabled interfaces or LACP-enabled trunk unless an LACP frame is first received on that interface or trunk. When operating in active mode, LACP immediately begins sending LACP frames from LACP-enabled interfaces and trunk.

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.



79
80
81
# File 'lib/icontrol/networking/trunk.rb', line 79

def active_lacp_state
  super
end

- (Object) add_interface(opts)

Adds the lists of interfaces to this trunk.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :interfaces (String[])

    The lists of interfaces to add to the specified trunks.

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.



29
30
31
32
# File 'lib/icontrol/networking/trunk.rb', line 29

def add_interface(opts)
  check_params(opts,[:interfaces])
  super
end

- (TrunkStatistics) all_statistics

Gets the statistics of all trunk.

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.



90
91
92
# File 'lib/icontrol/networking/trunk.rb', line 90

def all_statistics
  super
end

- (long) configured_member_count

Gets the number of configured links of this trunk.

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.



101
102
103
# File 'lib/icontrol/networking/trunk.rb', line 101

def configured_member_count
  super
end

- (Object) create(opts)

Creates this trunk.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :lacp_states (boolean)

    The LACP enabled states associated with the specified trunks.

  • :interfaces (String[])

    The interfaces associated with the specified trunks.

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.



43
44
45
46
# File 'lib/icontrol/networking/trunk.rb', line 43

def create(opts)
  check_params(opts,[:lacp_states,:interfaces])
  super
end

- (Object) delete_all_trunks

Deletes all trunk.

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.



54
55
56
# File 'lib/icontrol/networking/trunk.rb', line 54

def delete_all_trunks
  super
end

- (Object) delete_trunk

Deletes this trunk.

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.



64
65
66
# File 'lib/icontrol/networking/trunk.rb', line 64

def delete_trunk
  super
end

- (DistributionHashOption) distribution_hash_option

Gets the frame distribution hashing option used by this trunk.

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.



112
113
114
# File 'lib/icontrol/networking/trunk.rb', line 112

def distribution_hash_option
  super
end

- (String[]) interface

Gets the list of interfaces associated with this trunk.

Returns:

  • (String[])

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.



123
124
125
# File 'lib/icontrol/networking/trunk.rb', line 123

def interface
  super
end

- (EnabledState) lacp_enabled_state

Gets the states indicating whether LACP is enabled/disabled for this trunk.

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.



134
135
136
# File 'lib/icontrol/networking/trunk.rb', line 134

def lacp_enabled_state
  super
end

- (LACPTimeoutOption) lacp_timeout_option

Gets LACP timeout options for this trunk.

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.



145
146
147
# File 'lib/icontrol/networking/trunk.rb', line 145

def lacp_timeout_option
  super
end

Gets the link selection policies used by this trunk.

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.



156
157
158
# File 'lib/icontrol/networking/trunk.rb', line 156

def link_selection_policy
  super
end

- (String) list

Gets a list of all trunk on this device.

Returns:

  • (String)

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.



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

def list
  super
end

- (long) media_speed

Gets the current operational media speeds of this trunk. Unit = Mbps. This will be equivalent to the sum of the speeds of all operational links in a particular trunk.

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.



179
180
181
# File 'lib/icontrol/networking/trunk.rb', line 179

def media_speed
  super
end

- (MediaStatus) media_status

Gets the media status of this trunk.

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.



190
191
192
# File 'lib/icontrol/networking/trunk.rb', line 190

def media_status
  super
end

- (long) operational_member_count

Gets the current number of operational links of this trunk.

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.



201
202
203
# File 'lib/icontrol/networking/trunk.rb', line 201

def operational_member_count
  super
end

- (Object) remove_all_interfaces

Removes all interfaces from this trunk.

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.



261
262
263
# File 'lib/icontrol/networking/trunk.rb', line 261

def remove_all_interfaces
  super
end

- (Object) remove_interface(opts)

Removes the lists of interfaces from this trunk.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :interfaces (String[])

    The lists of interfaces to remove from the specified trunks.

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.



273
274
275
276
# File 'lib/icontrol/networking/trunk.rb', line 273

def remove_interface(opts)
  check_params(opts,[:interfaces])
  super
end

- (Object) reset_statistics

Resets the statistics of this trunk.

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.



284
285
286
# File 'lib/icontrol/networking/trunk.rb', line 284

def reset_statistics
  super
end

- (Object) set_active_lacp_state(opts)

Gets the states indicating whether LACP is operating in active or passive mode. When operating in passive mode, LACP will not send LACP frames out LACP-enabled interfaces or LACP-enabled trunk unless an LACP frame is first received on that interface or trunk. When operating in active mode, LACP immediately begins sending LACP frames from LACP-enabled interfaces and trunk.

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.



300
301
302
303
# File 'lib/icontrol/networking/trunk.rb', line 300

def set_active_lacp_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_distribution_hash_option(opts)

Sets the frame distribution hashing option used by this trunk.

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.



313
314
315
316
# File 'lib/icontrol/networking/trunk.rb', line 313

def set_distribution_hash_option(opts)
  check_params(opts,[:hashing_options])
  super
end

- (Object) set_lacp_enabled_state(opts)

Sets the states indicating whether LACP is enabled/disabled for this trunk.

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.



326
327
328
329
# File 'lib/icontrol/networking/trunk.rb', line 326

def set_lacp_enabled_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_lacp_timeout_option(opts)

Gets LACP timeout options for this trunk.

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.



339
340
341
342
# File 'lib/icontrol/networking/trunk.rb', line 339

def set_lacp_timeout_option(opts)
  check_params(opts,[:timeout_options])
  super
end

Sets the link selection policies used by this trunk.

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.



352
353
354
355
# File 'lib/icontrol/networking/trunk.rb', line 352

def set_link_selection_policy(opts)
  check_params(opts,[:policies])
  super
end

- (Object) set_stp_enabled_state(opts)

Sets the states indicating whether this trunk will participate in the spanning tree protocol. Disabling spanning tree protocol on a trunk enables learning and forwarding on it. The spanning tree algorithm then behaves as if the trunk did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the trunk, and the spanning tree algorithm exerts no control over forwarding or learning on the port. NOTE: For a trunk to participate in spanning tree protocol, the protocol must be enabled on all of its configured member interfaces.

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.



371
372
373
374
# File 'lib/icontrol/networking/trunk.rb', line 371

def set_stp_enabled_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_stp_protocol_detection_reset_state(opts)

Sets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on this trunk, until such time as a legacy STP bridge is detected again on those trunk. Note: This method is only applicable when the current STP mode is RSTP or MSTP.

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.



387
388
389
390
# File 'lib/icontrol/networking/trunk.rb', line 387

def set_stp_protocol_detection_reset_state(opts)
  check_params(opts,[:states])
  super
end

- (TrunkStatistics) statistics

Gets the statistics of this trunk.

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.



212
213
214
# File 'lib/icontrol/networking/trunk.rb', line 212

def statistics
  super
end

- (EnabledState) stp_enabled_state

Gets the states indicating whether this trunk will participate in the spanning tree protocol. Disabling spanning tree protocol on a trunk enables learning and forwarding on it. The spanning tree algorithm then behaves as if the trunk did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the trunk, and the spanning tree algorithm exerts no control over forwarding or learning on the port. NOTE: For a trunk to participate in spanning tree protocol, the protocol must be enabled on all of its configured member interfaces.

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.



229
230
231
# File 'lib/icontrol/networking/trunk.rb', line 229

def stp_enabled_state
  super
end

- (EnabledState) stp_protocol_detection_reset_state

Gets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on this trunk, until such time as a legacy STP bridge is detected again on those trunk. Note: This method is only applicable when the current STP mode is RSTP or MSTP.

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.



243
244
245
# File 'lib/icontrol/networking/trunk.rb', line 243

def stp_protocol_detection_reset_state
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


251
252
253
# File 'lib/icontrol/networking/trunk.rb', line 251

def version
  super
end