icontrol 0.3.1 → 0.3.2
Sign up to get free protection for your applications and to get access to all the features.
- data/lib/icontrol/arx.rb +38 -8
- data/lib/icontrol/arx/api.rb +1 -0
- data/lib/icontrol/arx/chassis.rb +11 -0
- data/lib/icontrol/arx/export.rb +4 -1
- data/lib/icontrol/arx/file_change_notification.rb +25 -4
- data/lib/icontrol/arx/file_server.rb +2 -0
- data/lib/icontrol/arx/namespace.rb +2 -0
- data/lib/icontrol/arx/network.rb +3 -0
- data/lib/icontrol/arx/policy.rb +3 -0
- data/lib/icontrol/arx/share.rb +2 -0
- data/lib/icontrol/arx/virtual_service.rb +3 -0
- data/lib/icontrol/arx/volume.rb +2 -0
- data/lib/icontrol/asm.rb +18 -3
- data/lib/icontrol/asm/object_params.rb +12 -6
- data/lib/icontrol/asm/policy.rb +118 -79
- data/lib/icontrol/asm/system_configuration.rb +27 -19
- data/lib/icontrol/asm/web_application.rb +74 -52
- data/lib/icontrol/asm/web_application_group.rb +33 -24
- data/lib/icontrol/base.rb +1 -0
- data/lib/icontrol/base/exception.rb +1 -0
- data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
- data/lib/icontrol/base/icontrol_overlay.rb +6 -0
- data/lib/icontrol/base/predeclarations.rb +5 -4
- data/lib/icontrol/base/struct.rb +6 -2
- data/lib/icontrol/common.rb +55 -4
- data/lib/icontrol/global_lb.rb +22 -3
- data/lib/icontrol/global_lb/application.rb +63 -44
- data/lib/icontrol/global_lb/data_center.rb +82 -58
- data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
- data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
- data/lib/icontrol/global_lb/globals.rb +662 -430
- data/lib/icontrol/global_lb/link.rb +181 -131
- data/lib/icontrol/global_lb/monitor.rb +174 -104
- data/lib/icontrol/global_lb/pool.rb +290 -203
- data/lib/icontrol/global_lb/pool_member.rb +118 -71
- data/lib/icontrol/global_lb/region.rb +37 -25
- data/lib/icontrol/global_lb/rule.rb +53 -37
- data/lib/icontrol/global_lb/server.rb +176 -124
- data/lib/icontrol/global_lb/topology.rb +41 -27
- data/lib/icontrol/global_lb/virtual_server.rb +118 -84
- data/lib/icontrol/global_lb/wide_ip.rb +168 -117
- data/lib/icontrol/local_lb.rb +81 -10
- data/lib/icontrol/local_lb/klass.rb +233 -153
- data/lib/icontrol/local_lb/monitor.rb +158 -96
- data/lib/icontrol/local_lb/nat.rb +74 -52
- data/lib/icontrol/local_lb/node_address.rb +123 -86
- data/lib/icontrol/local_lb/pool.rb +229 -164
- data/lib/icontrol/local_lb/pool_member.rb +134 -76
- data/lib/icontrol/local_lb/profile_auth.rb +103 -75
- data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
- data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
- data/lib/icontrol/local_lb/profile_dns.rb +65 -46
- data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
- data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
- data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
- data/lib/icontrol/local_lb/profile_http.rb +701 -433
- data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
- data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
- data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
- data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
- data/lib/icontrol/local_lb/profile_radius.rb +94 -62
- data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
- data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
- data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
- data/lib/icontrol/local_lb/profile_sip.rb +145 -99
- data/lib/icontrol/local_lb/profile_stream.rb +71 -51
- data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
- data/lib/icontrol/local_lb/profile_udp.rb +109 -78
- data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
- data/lib/icontrol/local_lb/profile_xml.rb +116 -79
- data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
- data/lib/icontrol/local_lb/rate_class.rb +523 -318
- data/lib/icontrol/local_lb/rule.rb +53 -37
- data/lib/icontrol/local_lb/snat.rb +96 -65
- data/lib/icontrol/local_lb/snat_pool.rb +54 -39
- data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
- data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
- data/lib/icontrol/local_lb/virtual_address.rb +99 -70
- data/lib/icontrol/local_lb/virtual_server.rb +358 -243
- data/lib/icontrol/lt_config.rb +8 -1
- data/lib/icontrol/lt_config/field.rb +87 -53
- data/lib/icontrol/lt_config/klass.rb +59 -43
- data/lib/icontrol/management.rb +80 -38
- data/lib/icontrol/management/ccldap_configuration.rb +218 -144
- data/lib/icontrol/management/change_control.rb +67 -41
- data/lib/icontrol/management/crldp_configuration.rb +73 -52
- data/lib/icontrol/management/crldp_server.rb +55 -39
- data/lib/icontrol/management/db_variable.rb +32 -21
- data/lib/icontrol/management/event_notification.rb +19 -8
- data/lib/icontrol/management/event_subscription.rb +121 -74
- data/lib/icontrol/management/key_certificate.rb +235 -138
- data/lib/icontrol/management/ldap_configuration.rb +249 -179
- data/lib/icontrol/management/license_administration.rb +97 -56
- data/lib/icontrol/management/named.rb +103 -67
- data/lib/icontrol/management/ocsp_configuration.rb +33 -24
- data/lib/icontrol/management/ocsp_responder.rb +294 -165
- data/lib/icontrol/management/partition.rb +42 -23
- data/lib/icontrol/management/provision.rb +73 -39
- data/lib/icontrol/management/radius_configuration.rb +85 -57
- data/lib/icontrol/management/radius_server.rb +51 -37
- data/lib/icontrol/management/resource_record.rb +163 -121
- data/lib/icontrol/management/snmp_configuration.rb +675 -390
- data/lib/icontrol/management/tacacs_configuration.rb +99 -67
- data/lib/icontrol/management/tmos_module.rb +20 -8
- data/lib/icontrol/management/user_management.rb +198 -124
- data/lib/icontrol/management/view.rb +33 -24
- data/lib/icontrol/management/zone.rb +49 -34
- data/lib/icontrol/management/zone_runner.rb +11 -7
- data/lib/icontrol/networking.rb +31 -4
- data/lib/icontrol/networking/admin_ip.rb +92 -71
- data/lib/icontrol/networking/arp.rb +41 -28
- data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
- data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
- data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
- data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
- data/lib/icontrol/networking/interfaces.rb +241 -142
- data/lib/icontrol/networking/packet_filter.rb +111 -69
- data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
- data/lib/icontrol/networking/port_mirror.rb +39 -27
- data/lib/icontrol/networking/profile_gre.rb +63 -41
- data/lib/icontrol/networking/profile_ipip.rb +38 -25
- data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
- data/lib/icontrol/networking/route_domain.rb +70 -44
- data/lib/icontrol/networking/route_table.rb +128 -91
- data/lib/icontrol/networking/self_ip.rb +57 -39
- data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
- data/lib/icontrol/networking/stp_globals.rb +115 -63
- data/lib/icontrol/networking/stp_instance.rb +166 -68
- data/lib/icontrol/networking/trunk.rb +165 -101
- data/lib/icontrol/networking/tunnel.rb +77 -52
- data/lib/icontrol/networking/vlan.rb +140 -98
- data/lib/icontrol/networking/vlan_group.rb +145 -101
- data/lib/icontrol/system.rb +70 -33
- data/lib/icontrol/system/cluster.rb +103 -81
- data/lib/icontrol/system/config_sync.rb +128 -72
- data/lib/icontrol/system/connections.rb +27 -17
- data/lib/icontrol/system/disk.rb +134 -67
- data/lib/icontrol/system/failover.rb +44 -27
- data/lib/icontrol/system/geo_ip.rb +16 -5
- data/lib/icontrol/system/inet.rb +47 -30
- data/lib/icontrol/system/internal.rb +13 -9
- data/lib/icontrol/system/services.rb +75 -42
- data/lib/icontrol/system/software_management.rb +132 -83
- data/lib/icontrol/system/statistics.rb +443 -298
- data/lib/icontrol/system/system_info.rb +137 -95
- data/lib/icontrol/web_accelerator/applications.rb +17 -10
- data/lib/icontrol/web_accelerator/policies.rb +13 -9
- data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
- data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
- data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
- metadata +10 -4
@@ -1,6 +1,7 @@
|
|
1
1
|
module IControl::Networking
|
2
2
|
##
|
3
|
-
# The STPInstance interface enables you to work with the definitions and attributes
|
3
|
+
# The STPInstance interface enables you to work with the definitions and attributes
|
4
|
+
# associated with an STP instance.
|
4
5
|
class STPInstance < IControl::Base
|
5
6
|
|
6
7
|
set_id_name "stp_instances"
|
@@ -10,12 +11,26 @@ module IControl::Networking
|
|
10
11
|
class InterfaceSTPRole < IControl::Base::Struct; end
|
11
12
|
class InterfaceSTPState < IControl::Base::Struct; end
|
12
13
|
class PathCost < IControl::Base::Struct; end
|
14
|
+
class InterfacePathCostSequence < IControl::Base::Sequence ; end
|
15
|
+
class InterfacePathCostSequenceSequence < IControl::Base::SequenceSequence ; end
|
16
|
+
class InterfacePrioritySequence < IControl::Base::Sequence ; end
|
17
|
+
class InterfacePrioritySequenceSequence < IControl::Base::SequenceSequence ; end
|
18
|
+
class InterfaceSTPRoleSequence < IControl::Base::Sequence ; end
|
19
|
+
class InterfaceSTPRoleSequenceSequence < IControl::Base::SequenceSequence ; end
|
20
|
+
class InterfaceSTPStateSequence < IControl::Base::Sequence ; end
|
21
|
+
class InterfaceSTPStateSequenceSequence < IControl::Base::SequenceSequence ; end
|
22
|
+
class PathCostSequence < IControl::Base::Sequence ; end
|
23
|
+
class PathCostTypeSequence < IControl::Base::Sequence ; end
|
24
|
+
class PathCostTypeSequenceSequence < IControl::Base::SequenceSequence ; end
|
13
25
|
# A list of path cost types.
|
14
26
|
class PathCostType < IControl::Base::Enumeration; end ##
|
15
|
-
# Adds/associates VLANs to this spanning tree instances. This method may be used only
|
16
|
-
#
|
17
|
-
#
|
18
|
-
# @
|
27
|
+
# Adds/associates VLANs to this spanning tree instances. This method may be used only
|
28
|
+
# in MSTP mode. In STP or RSTP mode, all VLANs automatically belong to spanning tree
|
29
|
+
# instance 0.
|
30
|
+
# @rspec_example
|
31
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
32
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
33
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
19
34
|
# @param [Hash] opts
|
20
35
|
# @option opts [String[]] :vlan_names The VLAN names to add to the spanning tree instances.
|
21
36
|
def add_vlan(opts)
|
@@ -25,9 +40,10 @@ module IControl::Networking
|
|
25
40
|
|
26
41
|
##
|
27
42
|
# Creates this spanning tree instances.
|
28
|
-
# @
|
29
|
-
# @raise [IControl::Common::
|
30
|
-
# @raise [IControl::Common::
|
43
|
+
# @rspec_example
|
44
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
45
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
46
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
31
47
|
# @param [Hash] opts
|
32
48
|
# @option opts [long] :priorities The per-instance bridge priorities.
|
33
49
|
# @option opts [String[]] :vlan_names The VLAN members that are under the control of the STP instances.
|
@@ -38,38 +54,50 @@ module IControl::Networking
|
|
38
54
|
|
39
55
|
##
|
40
56
|
# Deletes all spanning tree instances.
|
41
|
-
# @
|
42
|
-
# @raise [IControl::Common::
|
43
|
-
# @raise [IControl::Common::
|
57
|
+
# @rspec_example
|
58
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
59
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
60
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
44
61
|
def delete_all_instances
|
45
62
|
super
|
46
63
|
end
|
47
64
|
|
48
65
|
##
|
49
66
|
# Deletes this spanning tree instances.
|
50
|
-
# @
|
51
|
-
# @raise [IControl::Common::
|
52
|
-
# @raise [IControl::Common::
|
67
|
+
# @rspec_example
|
68
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
69
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
70
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
53
71
|
def delete_instance
|
54
72
|
super
|
55
73
|
end
|
56
74
|
|
57
75
|
##
|
58
|
-
# Gets the bridge priorities of this spanning tree instances. Each bridge in a spanning
|
76
|
+
# Gets the bridge priorities of this spanning tree instances. Each bridge in a spanning
|
77
|
+
# tree instance has a priority value, which controls the topoloty of the spanning tree
|
78
|
+
# chosen by the protocol. The bridge with the lowest priority value will become the
|
79
|
+
# root of the spanning tree. Priority values range from 0-61440 in steps of 4096. Hence,
|
80
|
+
# the supported priorities are: 0 16384 32768 49152 4096 20480 36864 53248 8192 24576
|
81
|
+
# 40960 57344 12288 28672 45056 61440 The default bridge priority is 61440, which will
|
82
|
+
# prevent BIGIP from being chosen as the root bridge. If this bridge priority is not
|
83
|
+
# one of the allowed values listed above, it is rounded down to the next lower value
|
84
|
+
# in the list. In STP or RSTP mode, only STP intance 0 is valid.
|
85
|
+
# @rspec_example
|
59
86
|
# @return [long]
|
60
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
61
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
62
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
87
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
88
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
89
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
63
90
|
def bridge_priority
|
64
91
|
super
|
65
92
|
end
|
66
93
|
|
67
94
|
##
|
68
95
|
# Gets the STP active states for this STP port objects.
|
96
|
+
# @rspec_example
|
69
97
|
# @return [InterfaceSTPState[]]
|
70
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
71
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
72
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
98
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
99
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
100
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
73
101
|
# @param [Hash] opts
|
74
102
|
# @option opts [String[]] :interfaces The interfaces/trunks from which to get the active states.
|
75
103
|
def interface_active_state(opts)
|
@@ -78,11 +106,26 @@ module IControl::Networking
|
|
78
106
|
end
|
79
107
|
|
80
108
|
##
|
81
|
-
# Gets the path costs for this network interfaces in this spanning tree instances.
|
109
|
+
# Gets the path costs for this network interfaces in this spanning tree instances.
|
110
|
+
# An interface path cost represents the relative cost of sending network traffic through
|
111
|
+
# that interface. In calculating the spanning tree, the algorithm tries to minimize
|
112
|
+
# the total path cost between each point and the root bridge. By manipulating the path
|
113
|
+
# costs of different interfaces, it's possible to steer traffic toward paths that are
|
114
|
+
# faster, more reliable, and/or more economical. Path costs have a range of 1-200,000,000,
|
115
|
+
# and the default path cost for an interface is based on the interface's maximum speed
|
116
|
+
# (not the actual speed). Max interface speed Default path cost 10 Gb/s 2,000
|
117
|
+
# 1 Gb/s 20,000 100 Mb/s 200,000 10 MB/s 2,000,000 The default path cost is
|
118
|
+
# a function of the interface's maximum speed, not its actual speed, so the default
|
119
|
+
# path cost of a 10/100/1000 Mb/s interface will be 20,000 even if the interface is
|
120
|
+
# running at 10 Mb/s. Changes in link speed don't cause path costs to change. Link
|
121
|
+
# aggregation doesn't affect the default path cost, i.e. a trunk of four 1 Gb/s interfaces
|
122
|
+
# will still have a default path cost of 20,000. In STP or RSTP mode, only STP intance
|
123
|
+
# 0 is valid.
|
124
|
+
# @rspec_example
|
82
125
|
# @return [InterfacePathCost[]]
|
83
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
84
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
85
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
126
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
127
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
128
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
86
129
|
# @param [Hash] opts
|
87
130
|
# @option opts [String[]] :interfaces The interfaces from which to get the interface path costs.
|
88
131
|
# @option opts [IControl::Networking::STPInstance::PathCostType[]] :path_cost_types The types of path costs (internal/external) to query.
|
@@ -92,11 +135,19 @@ module IControl::Networking
|
|
92
135
|
end
|
93
136
|
|
94
137
|
##
|
95
|
-
# Gets the priorities for this network interfaces in this spanning tree instances.
|
138
|
+
# Gets the priorities for this network interfaces in this spanning tree instances.
|
139
|
+
# These priority values influence which interfaces are chosen to carry network traffic.
|
140
|
+
# Interfaces with numerically lower values are favored to carry traffic. Interface
|
141
|
+
# priorities have values in the range from 0-240 in steps of 166. Hence, the supported
|
142
|
+
# priorities are: 0 64 128 192 16 80 144 208 32 96 160 224 48 112 176 240 The default
|
143
|
+
# interface priority is 128. If this interface priority is not one of the allowed values
|
144
|
+
# listed above, it is rounded down to the next lower value in the list. In STP or RSTP
|
145
|
+
# mode, only STP intance 0 is valid.
|
146
|
+
# @rspec_example
|
96
147
|
# @return [InterfacePriority[]]
|
97
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
98
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
99
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
148
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
149
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
150
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
100
151
|
# @param [Hash] opts
|
101
152
|
# @option opts [String[]] :interfaces The interfaces from which to get the interface priorities.
|
102
153
|
def interface_priority(opts)
|
@@ -106,10 +157,11 @@ module IControl::Networking
|
|
106
157
|
|
107
158
|
##
|
108
159
|
# Gets the STP requested/configured states for this STP port objects.
|
160
|
+
# @rspec_example
|
109
161
|
# @return [InterfaceSTPState[]]
|
110
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
111
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
112
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
162
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
163
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
164
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
113
165
|
# @param [Hash] opts
|
114
166
|
# @option opts [String[]] :interfaces The interfaces/trunks from which to get the active states.
|
115
167
|
def interface_requested_state(opts)
|
@@ -119,10 +171,11 @@ module IControl::Networking
|
|
119
171
|
|
120
172
|
##
|
121
173
|
# Gets the STP roles for this STP port objects.
|
174
|
+
# @rspec_example
|
122
175
|
# @return [InterfaceSTPRole[]]
|
123
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
124
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
125
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
176
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
177
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
178
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
126
179
|
# @param [Hash] opts
|
127
180
|
# @option opts [String[]] :interfaces The interfaces/trunks from which to get the active states.
|
128
181
|
def interface_role(opts)
|
@@ -132,65 +185,78 @@ module IControl::Networking
|
|
132
185
|
|
133
186
|
##
|
134
187
|
# Gets a list of all spanning tree instances.
|
188
|
+
# @rspec_example
|
135
189
|
# @return [long]
|
136
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
137
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
138
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
190
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
191
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
192
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
139
193
|
def list
|
140
194
|
super
|
141
195
|
end
|
142
196
|
|
143
197
|
##
|
144
198
|
# Gets the MAC addresses of the regional root bridges.
|
199
|
+
# @rspec_example
|
145
200
|
# @return [String]
|
146
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
147
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
148
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
201
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
202
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
203
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
149
204
|
def regional_root_bridge_mac_address
|
150
205
|
super
|
151
206
|
end
|
152
207
|
|
153
208
|
##
|
154
209
|
# Gets the MAC addresses of the root bridges.
|
210
|
+
# @rspec_example
|
155
211
|
# @return [String]
|
156
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
157
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
158
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
212
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
213
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
214
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
159
215
|
def root_bridge_mac_address
|
160
216
|
super
|
161
217
|
end
|
162
218
|
|
163
219
|
##
|
164
220
|
# Gets the version information for this interface.
|
221
|
+
# @rspec_example
|
165
222
|
# @return [String]
|
166
223
|
def version
|
167
224
|
super
|
168
225
|
end
|
169
226
|
|
170
227
|
##
|
171
|
-
# Gets the lists of VLANs this spanning tree instances are associated with. This method
|
228
|
+
# Gets the lists of VLANs this spanning tree instances are associated with. This method
|
229
|
+
# may be used only in MSTP mode. In STP or RSTP mode, all VLANs automatically belong
|
230
|
+
# to spanning tree instance 0.
|
231
|
+
# @rspec_example
|
172
232
|
# @return [String[]]
|
173
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
174
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
175
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
233
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
234
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
235
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
176
236
|
def vlan
|
177
237
|
super
|
178
238
|
end
|
179
239
|
|
180
240
|
##
|
181
|
-
# Removes all VLANs from this spanning tree instances. This method may be used only
|
182
|
-
#
|
183
|
-
#
|
184
|
-
# @
|
241
|
+
# Removes all VLANs from this spanning tree instances. This method may be used only
|
242
|
+
# in MSTP mode. In STP or RSTP mode, all VLANs automatically belong to spanning tree
|
243
|
+
# instance 0, and they can not be deleted from it.
|
244
|
+
# @rspec_example
|
245
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
246
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
247
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
185
248
|
def remove_all_vlans
|
186
249
|
super
|
187
250
|
end
|
188
251
|
|
189
252
|
##
|
190
|
-
# Removes VLANs from this spanning tree instances. This method may be used only in
|
191
|
-
#
|
192
|
-
#
|
193
|
-
# @
|
253
|
+
# Removes VLANs from this spanning tree instances. This method may be used only in
|
254
|
+
# MSTP mode. In STP or RSTP mode, all VLANs automatically belong to spanning tree instance
|
255
|
+
# 0, and they can not be deleted from it.
|
256
|
+
# @rspec_example
|
257
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
258
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
259
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
194
260
|
# @param [Hash] opts
|
195
261
|
# @option opts [String[]] :vlan_names The VLAN names to remove from the spanning tree instances.
|
196
262
|
def remove_vlan(opts)
|
@@ -199,10 +265,19 @@ module IControl::Networking
|
|
199
265
|
end
|
200
266
|
|
201
267
|
##
|
202
|
-
# Sets the bridge priorities of this spanning tree instances. Each bridge in a spanning
|
203
|
-
#
|
204
|
-
#
|
205
|
-
#
|
268
|
+
# Sets the bridge priorities of this spanning tree instances. Each bridge in a spanning
|
269
|
+
# tree instance has a priority value, which controls the topoloty of the spanning tree
|
270
|
+
# chosen by the protocol. The bridge with the lowest priority value will become the
|
271
|
+
# root of the spanning tree. Priority values range from 0-61440 in steps of 4096. Hence,
|
272
|
+
# the supported priorities are: 0 16384 32768 49152 4096 20480 36864 53248 8192 24576
|
273
|
+
# 40960 57344 12288 28672 45056 61440 The default bridge priority is 61440, which will
|
274
|
+
# prevent BIGIP from being chosen as the root bridge. If this bridge priority is not
|
275
|
+
# one of the allowed values listed above, it is rounded down to the next lower value
|
276
|
+
# in the list. In STP or RSTP mode, only STP intance 0 is valid.
|
277
|
+
# @rspec_example
|
278
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
279
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
280
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
206
281
|
# @param [Hash] opts
|
207
282
|
# @option opts [long] :priorities The bridge priorities of the specified spanning tree instances.
|
208
283
|
def set_bridge_priority(opts)
|
@@ -211,10 +286,25 @@ module IControl::Networking
|
|
211
286
|
end
|
212
287
|
|
213
288
|
##
|
214
|
-
# Sets the path costs for this network interfaces in this spanning tree instances.
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
289
|
+
# Sets the path costs for this network interfaces in this spanning tree instances.
|
290
|
+
# An interface path cost represents the relative cost of sending network traffic through
|
291
|
+
# that interface. In calculating the spanning tree, the algorithm tries to minimize
|
292
|
+
# the total path cost between each point and the root bridge. By manipulating the path
|
293
|
+
# costs of different interfaces, it's possible to steer traffic toward paths that are
|
294
|
+
# faster, more reliable, and/or more economical. Path costs have a range of 1-200,000,000,
|
295
|
+
# and the default path cost for an interface is based on the interface's maximum speed
|
296
|
+
# (not the actual speed). Max interface speed Default path cost 10 Gb/s 2,000
|
297
|
+
# 1 Gb/s 20,000 100 Mb/s 200,000 10 MB/s 2,000,000 The default path cost is
|
298
|
+
# a function of the interface's maximum speed, not its actual speed, so the default
|
299
|
+
# path cost of a 10/100/1000 Mb/s interface will be 20,000 even if the interface is
|
300
|
+
# running at 10 Mb/s. Changes in link speed don't cause path costs to change. Link
|
301
|
+
# aggregation doesn't affect the default path cost, i.e. a trunk of four 1 Gb/s interfaces
|
302
|
+
# will still have a default path cost of 20,000. In STP or RSTP mode, only STP intance
|
303
|
+
# 0 is valid.
|
304
|
+
# @rspec_example
|
305
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
306
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
307
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
218
308
|
# @param [Hash] opts
|
219
309
|
# @option opts [IControl::Networking::STPInstance::InterfacePathCost[]] :path_costs The interface path costs of the specified interfaces in the spanning tree instances.
|
220
310
|
def set_interface_path_cost(opts)
|
@@ -223,10 +313,18 @@ module IControl::Networking
|
|
223
313
|
end
|
224
314
|
|
225
315
|
##
|
226
|
-
# Sets the priorities for this network interfaces in this spanning tree instances.
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
316
|
+
# Sets the priorities for this network interfaces in this spanning tree instances.
|
317
|
+
# These priority values influence which interfaces are chosen to carry network traffic.
|
318
|
+
# Interfaces with numerically lower values are favored to carry traffic. Interface
|
319
|
+
# priorities have values in the range from 0-240 in steps of 166. Hence, the supported
|
320
|
+
# priorities are: 0 64 128 192 16 80 144 208 32 96 160 224 48 112 176 240 The default
|
321
|
+
# interface priority is 128. If this interface priority is not one of the allowed values
|
322
|
+
# listed above, it is rounded down to the next lower value in the list. In STP or RSTP
|
323
|
+
# mode, only STP intance 0 is valid.
|
324
|
+
# @rspec_example
|
325
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
326
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
327
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
230
328
|
# @param [Hash] opts
|
231
329
|
# @option opts [IControl::Networking::STPInstance::InterfacePriority[]] :priorities The interface priorities of the specified interfaces in the spanning tree instances.
|
232
330
|
def set_interface_priority(opts)
|
@@ -1,22 +1,29 @@
|
|
1
1
|
module IControl::Networking
|
2
2
|
##
|
3
|
-
# The Trunk interface enables you to work with the definitions and attributes contained
|
3
|
+
# The Trunk interface enables you to work with the definitions and attributes contained
|
4
|
+
# in a device's trunk.
|
4
5
|
class Trunk < IControl::Base
|
5
6
|
|
6
7
|
set_id_name "trunks"
|
7
8
|
|
8
9
|
class TrunkStatisticEntry < IControl::Base::Struct; end
|
9
10
|
class TrunkStatistics < IControl::Base::Struct; end
|
10
|
-
|
11
|
+
class DistributionHashOptionSequence < IControl::Base::Sequence ; end
|
12
|
+
class LACPTimeoutOptionSequence < IControl::Base::Sequence ; end
|
13
|
+
class LinkSelectionPolicySequence < IControl::Base::Sequence ; end
|
14
|
+
class TrunkStatisticEntrySequence < IControl::Base::Sequence ; end
|
15
|
+
# A list of frame distribution hashing options used to select which link to send the
|
16
|
+
# frame on, to maintain packet order.
|
11
17
|
class DistributionHashOption < IControl::Base::Enumeration; end
|
12
18
|
# A list of LACP timeout options.
|
13
19
|
class LACPTimeoutOption < IControl::Base::Enumeration; end
|
14
20
|
# A list of link selection policies.
|
15
21
|
class LinkSelectionPolicy < IControl::Base::Enumeration; end ##
|
16
22
|
# Adds the lists of interfaces to this trunk.
|
17
|
-
# @
|
18
|
-
# @raise [IControl::Common::
|
19
|
-
# @raise [IControl::Common::
|
23
|
+
# @rspec_example
|
24
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
25
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
26
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
20
27
|
# @param [Hash] opts
|
21
28
|
# @option opts [String[]] :interfaces The lists of interfaces to add to the specified trunks.
|
22
29
|
def add_interface(opts)
|
@@ -26,9 +33,10 @@ module IControl::Networking
|
|
26
33
|
|
27
34
|
##
|
28
35
|
# Creates this trunk.
|
29
|
-
# @
|
30
|
-
# @raise [IControl::Common::
|
31
|
-
# @raise [IControl::Common::
|
36
|
+
# @rspec_example
|
37
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
38
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
39
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
32
40
|
# @param [Hash] opts
|
33
41
|
# @option opts [boolean] :lacp_states The LACP enabled states associated with the specified trunks.
|
34
42
|
# @option opts [String[]] :interfaces The interfaces associated with the specified trunks.
|
@@ -39,174 +47,206 @@ module IControl::Networking
|
|
39
47
|
|
40
48
|
##
|
41
49
|
# Deletes all trunk.
|
42
|
-
# @
|
43
|
-
# @raise [IControl::Common::
|
44
|
-
# @raise [IControl::Common::
|
50
|
+
# @rspec_example
|
51
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
52
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
53
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
45
54
|
def delete_all_trunks
|
46
55
|
super
|
47
56
|
end
|
48
57
|
|
49
58
|
##
|
50
59
|
# Deletes this trunk.
|
51
|
-
# @
|
52
|
-
# @raise [IControl::Common::
|
53
|
-
# @raise [IControl::Common::
|
60
|
+
# @rspec_example
|
61
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
62
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
63
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
54
64
|
def delete_trunk
|
55
65
|
super
|
56
66
|
end
|
57
67
|
|
58
68
|
##
|
59
|
-
# Gets the states indicating whether LACP is operating in active or passive mode. When
|
69
|
+
# Gets the states indicating whether LACP is operating in active or passive mode. When
|
70
|
+
# operating in passive mode, LACP will not send LACP frames out LACP-enabled interfaces
|
71
|
+
# or LACP-enabled trunk unless an LACP frame is first received on that interface or
|
72
|
+
# trunk. When operating in active mode, LACP immediately begins sending LACP frames
|
73
|
+
# from LACP-enabled interfaces and trunk.
|
74
|
+
# @rspec_example
|
60
75
|
# @return [EnabledState]
|
61
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
62
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
63
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
76
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
77
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
78
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
64
79
|
def active_lacp_state
|
65
80
|
super
|
66
81
|
end
|
67
82
|
|
68
83
|
##
|
69
84
|
# Gets the statistics of all trunk.
|
85
|
+
# @rspec_example
|
70
86
|
# @return [TrunkStatistics]
|
71
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
72
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
73
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
87
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
88
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
89
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
74
90
|
def all_statistics
|
75
91
|
super
|
76
92
|
end
|
77
93
|
|
78
94
|
##
|
79
95
|
# Gets the number of configured links of this trunk.
|
96
|
+
# @rspec_example
|
80
97
|
# @return [long]
|
81
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
82
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
83
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
98
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
99
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
100
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
84
101
|
def configured_member_count
|
85
102
|
super
|
86
103
|
end
|
87
104
|
|
88
105
|
##
|
89
106
|
# Gets the frame distribution hashing option used by this trunk.
|
107
|
+
# @rspec_example
|
90
108
|
# @return [DistributionHashOption]
|
91
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
92
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
93
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
109
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
110
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
111
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
94
112
|
def distribution_hash_option
|
95
113
|
super
|
96
114
|
end
|
97
115
|
|
98
116
|
##
|
99
117
|
# Gets the list of interfaces associated with this trunk.
|
118
|
+
# @rspec_example
|
100
119
|
# @return [String[]]
|
101
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
102
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
103
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
120
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
121
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
122
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
104
123
|
def interface
|
105
124
|
super
|
106
125
|
end
|
107
126
|
|
108
127
|
##
|
109
128
|
# Gets the states indicating whether LACP is enabled/disabled for this trunk.
|
129
|
+
# @rspec_example
|
110
130
|
# @return [EnabledState]
|
111
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
112
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
113
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
131
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
132
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
133
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
114
134
|
def lacp_enabled_state
|
115
135
|
super
|
116
136
|
end
|
117
137
|
|
118
138
|
##
|
119
139
|
# Gets LACP timeout options for this trunk.
|
140
|
+
# @rspec_example
|
120
141
|
# @return [LACPTimeoutOption]
|
121
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
122
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
123
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
142
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
143
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
144
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
124
145
|
def lacp_timeout_option
|
125
146
|
super
|
126
147
|
end
|
127
148
|
|
128
149
|
##
|
129
150
|
# Gets the link selection policies used by this trunk.
|
151
|
+
# @rspec_example
|
130
152
|
# @return [LinkSelectionPolicy]
|
131
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
132
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
133
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
153
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
154
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
155
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
134
156
|
def link_selection_policy
|
135
157
|
super
|
136
158
|
end
|
137
159
|
|
138
160
|
##
|
139
161
|
# Gets a list of all trunk on this device.
|
162
|
+
# @rspec_example
|
140
163
|
# @return [String]
|
141
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
142
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
143
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
164
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
165
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
166
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
144
167
|
def list
|
145
168
|
super
|
146
169
|
end
|
147
170
|
|
148
171
|
##
|
149
|
-
# Gets the current operational media speeds of this trunk. Unit = Mbps. This will be
|
172
|
+
# Gets the current operational media speeds of this trunk. Unit = Mbps. This will be
|
173
|
+
# equivalent to the sum of the speeds of all operational links in a particular trunk.
|
174
|
+
# @rspec_example
|
150
175
|
# @return [long]
|
151
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
152
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
153
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
176
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
177
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
178
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
154
179
|
def media_speed
|
155
180
|
super
|
156
181
|
end
|
157
182
|
|
158
183
|
##
|
159
184
|
# Gets the media status of this trunk.
|
185
|
+
# @rspec_example
|
160
186
|
# @return [MediaStatus]
|
161
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
162
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
163
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
187
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
188
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
189
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
164
190
|
def media_status
|
165
191
|
super
|
166
192
|
end
|
167
193
|
|
168
194
|
##
|
169
195
|
# Gets the current number of operational links of this trunk.
|
196
|
+
# @rspec_example
|
170
197
|
# @return [long]
|
171
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
172
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
173
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
198
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
199
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
200
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
174
201
|
def operational_member_count
|
175
202
|
super
|
176
203
|
end
|
177
204
|
|
178
205
|
##
|
179
206
|
# Gets the statistics of this trunk.
|
207
|
+
# @rspec_example
|
180
208
|
# @return [TrunkStatistics]
|
181
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
182
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
183
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
209
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
210
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
211
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
184
212
|
def statistics
|
185
213
|
super
|
186
214
|
end
|
187
215
|
|
188
216
|
##
|
189
|
-
# Gets the states indicating whether this trunk will participate in the spanning tree
|
217
|
+
# Gets the states indicating whether this trunk will participate in the spanning tree
|
218
|
+
# protocol. Disabling spanning tree protocol on a trunk enables learning and forwarding
|
219
|
+
# on it. The spanning tree algorithm then behaves as if the trunk did not exist. No
|
220
|
+
# STP, RSTP, or MSTP packets are transmitted or received on the trunk, and the spanning
|
221
|
+
# tree algorithm exerts no control over forwarding or learning on the port. NOTE: For
|
222
|
+
# a trunk to participate in spanning tree protocol, the protocol must be enabled on
|
223
|
+
# all of its configured member interfaces.
|
224
|
+
# @rspec_example
|
190
225
|
# @return [EnabledState]
|
191
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
192
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
193
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
226
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
227
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
228
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
194
229
|
def stp_enabled_state
|
195
230
|
super
|
196
231
|
end
|
197
232
|
|
198
233
|
##
|
199
|
-
# Gets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP
|
234
|
+
# Gets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP
|
235
|
+
# mode) to be sent on this trunk, until such time as a legacy STP bridge is detected
|
236
|
+
# again on those trunk. Note: This method is only applicable when the current STP mode
|
237
|
+
# is RSTP or MSTP.
|
238
|
+
# @rspec_example
|
200
239
|
# @return [EnabledState]
|
201
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
202
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
203
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
240
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
241
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
242
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
204
243
|
def stp_protocol_detection_reset_state
|
205
244
|
super
|
206
245
|
end
|
207
246
|
|
208
247
|
##
|
209
248
|
# Gets the version information for this interface.
|
249
|
+
# @rspec_example
|
210
250
|
# @return [String]
|
211
251
|
def version
|
212
252
|
super
|
@@ -214,18 +254,20 @@ module IControl::Networking
|
|
214
254
|
|
215
255
|
##
|
216
256
|
# Removes all interfaces from this trunk.
|
217
|
-
# @
|
218
|
-
# @raise [IControl::Common::
|
219
|
-
# @raise [IControl::Common::
|
257
|
+
# @rspec_example
|
258
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
259
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
260
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
220
261
|
def remove_all_interfaces
|
221
262
|
super
|
222
263
|
end
|
223
264
|
|
224
265
|
##
|
225
266
|
# Removes the lists of interfaces from this trunk.
|
226
|
-
# @
|
227
|
-
# @raise [IControl::Common::
|
228
|
-
# @raise [IControl::Common::
|
267
|
+
# @rspec_example
|
268
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
269
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
270
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
229
271
|
# @param [Hash] opts
|
230
272
|
# @option opts [String[]] :interfaces The lists of interfaces to remove from the specified trunks.
|
231
273
|
def remove_interface(opts)
|
@@ -235,18 +277,24 @@ module IControl::Networking
|
|
235
277
|
|
236
278
|
##
|
237
279
|
# Resets the statistics of this trunk.
|
238
|
-
# @
|
239
|
-
# @raise [IControl::Common::
|
240
|
-
# @raise [IControl::Common::
|
280
|
+
# @rspec_example
|
281
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
282
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
283
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
241
284
|
def reset_statistics
|
242
285
|
super
|
243
286
|
end
|
244
287
|
|
245
288
|
##
|
246
|
-
# Gets the states indicating whether LACP is operating in active or passive mode. When
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
289
|
+
# Gets the states indicating whether LACP is operating in active or passive mode. When
|
290
|
+
# operating in passive mode, LACP will not send LACP frames out LACP-enabled interfaces
|
291
|
+
# or LACP-enabled trunk unless an LACP frame is first received on that interface or
|
292
|
+
# trunk. When operating in active mode, LACP immediately begins sending LACP frames
|
293
|
+
# from LACP-enabled interfaces and trunk.
|
294
|
+
# @rspec_example
|
295
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
296
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
297
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
250
298
|
# @param [Hash] opts
|
251
299
|
# @option opts [IControl::Common::EnabledState] :states The states indicating whether active LACP is enabled/disabled.
|
252
300
|
def set_active_lacp_state(opts)
|
@@ -256,9 +304,10 @@ module IControl::Networking
|
|
256
304
|
|
257
305
|
##
|
258
306
|
# Sets the frame distribution hashing option used by this trunk.
|
259
|
-
# @
|
260
|
-
# @raise [IControl::Common::
|
261
|
-
# @raise [IControl::Common::
|
307
|
+
# @rspec_example
|
308
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
309
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
310
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
262
311
|
# @param [Hash] opts
|
263
312
|
# @option opts [IControl::Networking::Trunk::DistributionHashOption] :hashing_options The frame distribution hashing option used by the specified trunks..
|
264
313
|
def set_distribution_hash_option(opts)
|
@@ -268,9 +317,10 @@ module IControl::Networking
|
|
268
317
|
|
269
318
|
##
|
270
319
|
# Sets the states indicating whether LACP is enabled/disabled for this trunk.
|
271
|
-
# @
|
272
|
-
# @raise [IControl::Common::
|
273
|
-
# @raise [IControl::Common::
|
320
|
+
# @rspec_example
|
321
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
322
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
323
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
274
324
|
# @param [Hash] opts
|
275
325
|
# @option opts [IControl::Common::EnabledState] :states The states indicating whether LACP is enabled/disabled for the specified trunks.
|
276
326
|
def set_lacp_enabled_state(opts)
|
@@ -280,9 +330,10 @@ module IControl::Networking
|
|
280
330
|
|
281
331
|
##
|
282
332
|
# Gets LACP timeout options for this trunk.
|
283
|
-
# @
|
284
|
-
# @raise [IControl::Common::
|
285
|
-
# @raise [IControl::Common::
|
333
|
+
# @rspec_example
|
334
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
335
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
336
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
286
337
|
# @param [Hash] opts
|
287
338
|
# @option opts [IControl::Networking::Trunk::LACPTimeoutOption] :timeout_options The LACP timeout options for the specified trunks.
|
288
339
|
def set_lacp_timeout_option(opts)
|
@@ -292,9 +343,10 @@ module IControl::Networking
|
|
292
343
|
|
293
344
|
##
|
294
345
|
# Sets the link selection policies used by this trunk.
|
295
|
-
# @
|
296
|
-
# @raise [IControl::Common::
|
297
|
-
# @raise [IControl::Common::
|
346
|
+
# @rspec_example
|
347
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
348
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
349
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
298
350
|
# @param [Hash] opts
|
299
351
|
# @option opts [IControl::Networking::Trunk::LinkSelectionPolicy] :policies The link selection policies used by the specified trunks.
|
300
352
|
def set_link_selection_policy(opts)
|
@@ -303,10 +355,17 @@ module IControl::Networking
|
|
303
355
|
end
|
304
356
|
|
305
357
|
##
|
306
|
-
# Sets the states indicating whether this trunk will participate in the spanning tree
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
358
|
+
# Sets the states indicating whether this trunk will participate in the spanning tree
|
359
|
+
# protocol. Disabling spanning tree protocol on a trunk enables learning and forwarding
|
360
|
+
# on it. The spanning tree algorithm then behaves as if the trunk did not exist. No
|
361
|
+
# STP, RSTP, or MSTP packets are transmitted or received on the trunk, and the spanning
|
362
|
+
# tree algorithm exerts no control over forwarding or learning on the port. NOTE: For
|
363
|
+
# a trunk to participate in spanning tree protocol, the protocol must be enabled on
|
364
|
+
# all of its configured member interfaces.
|
365
|
+
# @rspec_example
|
366
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
367
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
368
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
310
369
|
# @param [Hash] opts
|
311
370
|
# @option opts [IControl::Common::EnabledState] :states The STP enabled states to set for the specified interface names.
|
312
371
|
def set_stp_enabled_state(opts)
|
@@ -315,10 +374,14 @@ module IControl::Networking
|
|
315
374
|
end
|
316
375
|
|
317
376
|
##
|
318
|
-
# Sets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
377
|
+
# Sets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP
|
378
|
+
# mode) to be sent on this trunk, until such time as a legacy STP bridge is detected
|
379
|
+
# again on those trunk. Note: This method is only applicable when the current STP mode
|
380
|
+
# is RSTP or MSTP.
|
381
|
+
# @rspec_example
|
382
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
383
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
384
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
322
385
|
# @param [Hash] opts
|
323
386
|
# @option opts [IControl::Common::EnabledState] :states The STP protocol detection reset states to set for the specified interface names.
|
324
387
|
def set_stp_protocol_detection_reset_state(opts)
|
@@ -329,18 +392,18 @@ module IControl::Networking
|
|
329
392
|
##
|
330
393
|
# A struct that describes a trunk's general statistics.
|
331
394
|
# @attr [String] trunk_name The trunk name.
|
332
|
-
# @attr [IControl::Common::
|
395
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics.
|
333
396
|
class TrunkStatisticEntry < IControl::Base::Struct
|
334
397
|
icontrol_attribute :trunk_name, String
|
335
|
-
icontrol_attribute :statistics, IControl::Common::
|
398
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
336
399
|
end
|
337
400
|
|
338
401
|
##
|
339
402
|
# A struct that describes trunk statistics and timestamp.
|
340
|
-
# @attr [IControl::Networking::Trunk::
|
403
|
+
# @attr [IControl::Networking::Trunk::TrunkStatisticEntrySequence] statistics The statistics for a sequence of trunks.
|
341
404
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
342
405
|
class TrunkStatistics < IControl::Base::Struct
|
343
|
-
icontrol_attribute :statistics, IControl::Networking::Trunk::
|
406
|
+
icontrol_attribute :statistics, IControl::Networking::Trunk::TrunkStatisticEntrySequence
|
344
407
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
345
408
|
end
|
346
409
|
|
@@ -353,7 +416,8 @@ module IControl::Networking
|
|
353
416
|
class LinkSelectionPolicySequence < IControl::Base::Sequence ; end
|
354
417
|
## A sequence of trunk statistics.
|
355
418
|
class TrunkStatisticEntrySequence < IControl::Base::Sequence ; end
|
356
|
-
# A list of frame distribution hashing options used to select which link to send the
|
419
|
+
# A list of frame distribution hashing options used to select which link to send the
|
420
|
+
# frame on, to maintain packet order.
|
357
421
|
class DistributionHashOption < IControl::Base::Enumeration
|
358
422
|
# Hash on the destination MAC address.
|
359
423
|
DISTRIBUTION_HASH_OPTION_DST_MAC = :DISTRIBUTION_HASH_OPTION_DST_MAC
|