Class: IControl::Networking::VLANGroup

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

Overview

The VLANGroup interface enables you to work with the definitions and attributes contained in a device's VLAN group.

Defined Under Namespace

Classes: VLANGroupTransparency, VLANGroupTransparencySequence

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

#add_global_proxy_exclusion(opts) ⇒ Object

Adds this IP addresses to the global proxy ARP exclusion list that applies to all VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :addresses (String)

    The lists of IP addresses.

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.


20
21
22
23
# File 'lib/icontrol/networking/vlan_group.rb', line 20

def add_global_proxy_exclusion(opts)
  opts = check_params(opts,[:addresses])
  super(opts)
end

#add_member(opts) ⇒ Object

Adds this children VLANs to this VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :member_vlans (String[])

    The lists of child VLANs .

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.


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

def add_member(opts)
  opts = check_params(opts,[:member_vlans])
  super(opts)
end

#add_proxy_exclusion(opts) ⇒ Object

Adds this IP addresses to the proxy ARP exclusion lists of this VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :addresses (String[])

    The lists of IP addresses.

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
49
# File 'lib/icontrol/networking/vlan_group.rb', line 46

def add_proxy_exclusion(opts)
  opts = check_params(opts,[:addresses])
  super(opts)
end

#bridge_all_traffic_stateEnabledState

Gets the states to indicate whether to bridge non-IP traffic as well as IP traffic for this VLAN groups.

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.


106
107
108
# File 'lib/icontrol/networking/vlan_group.rb', line 106

def bridge_all_traffic_state
  super
end

#bridge_in_standby_stateEnabledState

Gets the states to indicate whether to bridge while unit is in standby mode for this VLAN groups.

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.


118
119
120
# File 'lib/icontrol/networking/vlan_group.rb', line 118

def bridge_in_standby_state
  super
end

#bridge_multicast_stateEnabledState

Gets the states to indicate whether to bridge multicast/broadcast traffic for this VLAN groups.

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.


130
131
132
# File 'lib/icontrol/networking/vlan_group.rb', line 130

def bridge_multicast_state
  super
end

#create(opts) ⇒ Object

This method has been deprecated; please use create_v2 instead. Creates a VLAN group.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :vlan_ids (long)

    The VLAN tag numbers or IDs (valid range is 1-4095).

  • :member_vlans (String[])

    The lists of member VLANs .

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.


60
61
62
63
# File 'lib/icontrol/networking/vlan_group.rb', line 60

def create(opts)
  opts = check_params(opts,[:vlan_ids,:member_vlans])
  super(opts)
end

#create_v2(opts) ⇒ Object

Creates a VLAN group.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :member_vlans (String[])

    The lists of member VLANs .

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.


73
74
75
76
# File 'lib/icontrol/networking/vlan_group.rb', line 73

def create_v2(opts)
  opts = check_params(opts,[:member_vlans])
  super(opts)
end

#delete_all_vlan_groupsObject

Deletes all VLAN groups.

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.


84
85
86
# File 'lib/icontrol/networking/vlan_group.rb', line 84

def delete_all_vlan_groups
  super
end

#delete_vlan_groupObject

Deletes this VLAN groups.

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/vlan_group.rb', line 94

def delete_vlan_group
  super
end

#global_proxy_exclusionString

Gets the global lists of IP addresses that proxy ARP will ignore for all VLAN groups.

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.


141
142
143
# File 'lib/icontrol/networking/vlan_group.rb', line 141

def global_proxy_exclusion
  super
end

#listString

Gets a list of all VLAN groups 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.


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

def list
  super
end

#mac_masquerade_addressString

Gets the MAC masquerade addresses for this VLAN groups.

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.


163
164
165
# File 'lib/icontrol/networking/vlan_group.rb', line 163

def mac_masquerade_address
  super
end

#memberString[]

Gets the lists of children VLANs of this VLAN groups.

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.


174
175
176
# File 'lib/icontrol/networking/vlan_group.rb', line 174

def member
  super
end

#proxy_exclusionString[]

Gets the lists of IP addresses that proxy ARP will ignore for this VLAN groups.

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.


185
186
187
# File 'lib/icontrol/networking/vlan_group.rb', line 185

def proxy_exclusion
  super
end

#remove_all_global_proxy_exclusionsObject

Removes all IP addresses from the global proxy ARP exclusion list for all VLAN groups.

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.


238
239
240
# File 'lib/icontrol/networking/vlan_group.rb', line 238

def remove_all_global_proxy_exclusions
  super
end

#remove_all_membersObject

Removes all children VLANs from this VLAN groups.

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.


248
249
250
# File 'lib/icontrol/networking/vlan_group.rb', line 248

def remove_all_members
  super
end

#remove_all_proxy_exclusionsObject

Removes all IP addresses from the proxy ARP exclusion lists of this VLAN groups.

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.


258
259
260
# File 'lib/icontrol/networking/vlan_group.rb', line 258

def remove_all_proxy_exclusions
  super
end

#remove_global_proxy_exclusion(opts) ⇒ Object

Removes this IP addresses from the global proxy ARP exclusion list that applies to all VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :addresses (String)

    The lists of IP addresses.

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.


271
272
273
274
# File 'lib/icontrol/networking/vlan_group.rb', line 271

def remove_global_proxy_exclusion(opts)
  opts = check_params(opts,[:addresses])
  super(opts)
end

#remove_member(opts) ⇒ Object

Removes this children VLANs from this VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :member_vlans (String[])

    The lists of child VLANs .

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
287
# File 'lib/icontrol/networking/vlan_group.rb', line 284

def remove_member(opts)
  opts = check_params(opts,[:member_vlans])
  super(opts)
end

#remove_proxy_exclusion(opts) ⇒ Object

Removes this IP addresses from the proxy ARP exclusion lists of this VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :addresses (String[])

    The lists of IP addresses.

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.


297
298
299
300
# File 'lib/icontrol/networking/vlan_group.rb', line 297

def remove_proxy_exclusion(opts)
  opts = check_params(opts,[:addresses])
  super(opts)
end

#set_bridge_all_traffic_state(opts) ⇒ Object

Sets the states to indicate whether to bridge non-IP traffic as well as IP traffic for this VLAN groups.

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.


311
312
313
314
# File 'lib/icontrol/networking/vlan_group.rb', line 311

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

#set_bridge_in_standby_state(opts) ⇒ Object

Sets the states to indicate whether to bridge while unit is in standby mode for this VLAN groups.

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.


325
326
327
328
# File 'lib/icontrol/networking/vlan_group.rb', line 325

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

#set_bridge_multicast_state(opts) ⇒ Object

Sets the states to indicate whether to bridge multicast/broadcast traffic for this VLAN groups.

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/vlan_group.rb', line 339

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

#set_mac_masquerade_address(opts) ⇒ Object

Sets the MAC masquerade addresses for this VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :mac_masquerade_addresses (String)

    The MAC masquerade addresses to set for the specified VLAN groups.

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/vlan_group.rb', line 352

def set_mac_masquerade_address(opts)
  opts = check_params(opts,[:mac_masquerade_addresses])
  super(opts)
end

#set_transparency_mode(opts) ⇒ Object

Sets the transparency modes for this VLAN groups.

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.


365
366
367
368
# File 'lib/icontrol/networking/vlan_group.rb', line 365

def set_transparency_mode(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_vlan_id(opts) ⇒ Object

This method has been deprecated; setting VLAN id for a VLAN group had and will have no effect. Please don't use in the future. Sets the tag ids for this VLAN groups.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :vlan_ids (long)

    The VLAN ID/tag numbers (valid range is 1-4095).

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.


379
380
381
382
# File 'lib/icontrol/networking/vlan_group.rb', line 379

def set_vlan_id(opts)
  opts = check_params(opts,[:vlan_ids])
  super(opts)
end

#transparency_modeVLANGroupTransparency

Gets the transparency modes for this VLAN groups.

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.


196
197
198
# File 'lib/icontrol/networking/vlan_group.rb', line 196

def transparency_mode
  super
end

#true_mac_addressString

Gets the true MAC addresses used by this VLAN groups.

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.


207
208
209
# File 'lib/icontrol/networking/vlan_group.rb', line 207

def true_mac_address
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

215
216
217
# File 'lib/icontrol/networking/vlan_group.rb', line 215

def version
  super
end

#vlan_idlong

This method has been deprecated; accessing VLAN id for a VLAN group was unnecessary and misleading. The method now returns 0s. Please don't use in the future. Gets the ids for this VLAN groups.

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.


228
229
230
# File 'lib/icontrol/networking/vlan_group.rb', line 228

def vlan_id
  super
end