icontrol 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -10,58 +10,68 @@ module IControl::Networking
10
10
  class NDPEntry < IControl::Base::Struct; end
11
11
  class NDPStatistics < IControl::Base::Struct; end
12
12
  class StaticEntry < IControl::Base::Struct; end
13
+ class ARPEntrySequence < IControl::Base::Sequence ; end
14
+ class NDPEntrySequence < IControl::Base::Sequence ; end
15
+ class NDPStateSequence < IControl::Base::Sequence ; end
16
+ class StaticEntrySequence < IControl::Base::Sequence ; end
13
17
  # A list of NDP (Neighbor Discovery Protocol) states.
14
18
  class NDPState < IControl::Base::Enumeration; end ##
15
19
  # Creates/adds this static ARP/NDP entrie to the ARP/NDP table.
16
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
17
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
18
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
20
+ # @rspec_example
21
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
22
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
23
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
19
24
  def add_static_entry
20
25
  super
21
26
  end
22
27
 
23
28
  ##
24
29
  # Deletes all dynamic ARP entrie from the ARP table.
25
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
26
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
27
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
28
34
  def delete_all_dynamic_arps
29
35
  super
30
36
  end
31
37
 
32
38
  ##
33
39
  # Deletes all dynamic NDP entrie from the NDP table.
34
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
35
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
36
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
40
+ # @rspec_example
41
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
42
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
43
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
37
44
  def delete_all_dynamic_ndps
38
45
  super
39
46
  end
40
47
 
41
48
  ##
42
49
  # Deletes all static ARP/NDP entrie from the ARP/NDP table.
43
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
46
54
  def delete_all_static_entries
47
55
  super
48
56
  end
49
57
 
50
58
  ##
51
59
  # Deletes this static ARP/NDP entrie from the ARP/NDP table.
52
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
55
64
  def delete_static_entry
56
65
  super
57
66
  end
58
67
 
59
68
  ##
60
69
  # Gets the dynamic ARP statistics for this ARP addresses.
70
+ # @rspec_example
61
71
  # @return [ARPStatistics]
62
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
72
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
73
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
74
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
65
75
  # @param [Hash] opts
66
76
  # @option opts [String] :arp_addresses The ARP IP addresses.
67
77
  def dynamic_arp(opts)
@@ -71,10 +81,11 @@ module IControl::Networking
71
81
 
72
82
  ##
73
83
  # Gets the dynamic NDP statistics for this NDP addresses.
84
+ # @rspec_example
74
85
  # @return [NDPStatistics]
75
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
76
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
77
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
86
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
87
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
88
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
78
89
  # @param [Hash] opts
79
90
  # @option opts [String] :ndp_addresses The NDP IP addresses.
80
91
  def dynamic_ndp(opts)
@@ -84,16 +95,18 @@ module IControl::Networking
84
95
 
85
96
  ##
86
97
  # Gets a list of all static ARP/NDP entrie.
98
+ # @rspec_example
87
99
  # @return [StaticEntry]
88
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
89
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
90
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
100
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
101
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
102
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
91
103
  def static_entry
92
104
  super
93
105
  end
94
106
 
95
107
  ##
96
108
  # Gets the version information for this interface.
109
+ # @rspec_example
97
110
  # @return [String]
98
111
  def version
99
112
  super
@@ -122,10 +135,10 @@ module IControl::Networking
122
135
 
123
136
  ##
124
137
  # A struct that describes ARP statistics and timestamp.
125
- # @attr [IControl::Networking::ARP::ARPEntry] statistics The statistics for a sequence of ARP entries.
138
+ # @attr [IControl::Networking::ARP::ARPEntrySequence] statistics The statistics for a sequence of ARP entries.
126
139
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
127
140
  class ARPStatistics < IControl::Base::Struct
128
- icontrol_attribute :statistics, IControl::Networking::ARP::ARPEntry
141
+ icontrol_attribute :statistics, IControl::Networking::ARP::ARPEntrySequence
129
142
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
130
143
  end
131
144
 
@@ -148,10 +161,10 @@ module IControl::Networking
148
161
 
149
162
  ##
150
163
  # A struct that describes NDP statistics and timestamp.
151
- # @attr [IControl::Networking::ARP::NDPEntry] statistics The statistics for a sequence of NDP entries.
164
+ # @attr [IControl::Networking::ARP::NDPEntrySequence] statistics The statistics for a sequence of NDP entries.
152
165
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
153
166
  class NDPStatistics < IControl::Base::Struct
154
- icontrol_attribute :statistics, IControl::Networking::ARP::NDPEntry
167
+ icontrol_attribute :statistics, IControl::Networking::ARP::NDPEntrySequence
155
168
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
156
169
  end
157
170
 
@@ -1,16 +1,21 @@
1
1
  module IControl::Networking
2
2
  ##
3
- # The iSession AdvertisedRoute interface enables you to work with the definitions and attributes contained in a device's optimized endpoint subnets.
3
+ # The iSession AdvertisedRoute interface enables you to work with the definitions and
4
+ # attributes contained in a device's optimized endpoint subnets.
4
5
  class ISessionAdvertisedRoute < IControl::Base
5
6
 
6
7
  set_id_name "subnets"
7
8
 
8
9
  class SubnetOptKey < IControl::Base::Struct; end
9
- class ISessionAdvertisedRouteStruct < IControl::Base::Struct; end ##
10
+ class ISessionAdvertisedRouteStruct < IControl::Base::Struct; end
11
+ class SubnetOptKeySequence < IControl::Base::Sequence ; end
12
+ class SubnetOptKeySequenceSequence < IControl::Base::SequenceSequence ; end
13
+ class ISessionAdvertisedRouteStructSequence < IControl::Base::Sequence ; end ##
10
14
  # Creates a specified subnet object with all its attributes.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
15
+ # @rspec_example
16
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
17
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
18
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
19
  # @param [Hash] opts
15
20
  # @option opts [IControl::Networking::iSessionAdvertisedRoute::iSessionAdvertisedRouteStruct] :subnet The subnet struct to create.
16
21
  def create(opts)
@@ -20,64 +25,71 @@ module IControl::Networking
20
25
 
21
26
  ##
22
27
  # Deletes all exisiting subnet objects.
23
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
24
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
25
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
28
+ # @rspec_example
29
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
30
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
31
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
26
32
  def delete_all_subnets
27
33
  super
28
34
  end
29
35
 
30
36
  ##
31
37
  # Deletes this subnet via its IP address and netmask.
32
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
33
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
34
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
38
+ # @rspec_example
39
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
40
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
41
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
35
42
  def delete_subnets
36
43
  super
37
44
  end
38
45
 
39
46
  ##
40
47
  # Gets the enabled flag on the target subnet.
48
+ # @rspec_example
41
49
  # @return [EnabledState]
42
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
43
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
44
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
50
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
51
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
52
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
45
53
  def enabled_state
46
54
  super
47
55
  end
48
56
 
49
57
  ##
50
58
  # Gets the label string on the target subnet.
59
+ # @rspec_example
51
60
  # @return [String]
52
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
55
64
  def label
56
65
  super
57
66
  end
58
67
 
59
68
  ##
60
69
  # Get a list of all subnet interfaces and their netmasks.
70
+ # @rspec_example
61
71
  # @return [SubnetOptKey]
62
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
72
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
73
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
74
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
65
75
  def list
66
76
  super
67
77
  end
68
78
 
69
79
  ##
70
80
  # Gets the metric with which this subnet IPs are associated.
81
+ # @rspec_example
71
82
  # @return [long]
72
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
73
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
74
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
83
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
84
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
85
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
75
86
  def metric
76
87
  super
77
88
  end
78
89
 
79
90
  ##
80
91
  # Gets the version information for this interface.
92
+ # @rspec_example
81
93
  # @return [String]
82
94
  def version
83
95
  super
@@ -85,9 +97,10 @@ module IControl::Networking
85
97
 
86
98
  ##
87
99
  # Sets/Resets the enabled flag on the target subnet.
88
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
89
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
90
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
100
+ # @rspec_example
101
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
102
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
103
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
91
104
  # @param [Hash] opts
92
105
  # @option opts [IControl::Networking::iSessionAdvertisedRoute::SubnetOptKey] :ip The subnet IP.
93
106
  # @option opts [IControl::Common::EnabledState] :included The new included setting.
@@ -98,9 +111,10 @@ module IControl::Networking
98
111
 
99
112
  ##
100
113
  # Sets/Resets the label string on the target subnet.
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.
114
+ # @rspec_example
115
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
104
118
  # @param [Hash] opts
105
119
  # @option opts [IControl::Networking::iSessionAdvertisedRoute::SubnetOptKey] :ip The subnet IP.
106
120
  # @option opts [String] :labels The new subnet labels
@@ -111,9 +125,10 @@ module IControl::Networking
111
125
 
112
126
  ##
113
127
  # Sets the metric with which this subnet IPs are associated.
114
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
115
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
116
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
128
+ # @rspec_example
129
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
130
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
131
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
117
132
  # @param [Hash] opts
118
133
  # @option opts [IControl::Networking::iSessionAdvertisedRoute::SubnetOptKey] :subnet The subnet IPs .
119
134
  # @option opts [long] :metric value.
@@ -1,16 +1,19 @@
1
1
  module IControl::Networking
2
2
  ##
3
- # The iSession Local interface enables you to work with the definitions and attributes contained in a device's local endpoint object.
3
+ # The iSession Local interface enables you to work with the definitions and attributes
4
+ # contained in a device's local endpoint object.
4
5
  class ISessionLocalInterface < IControl::Base
5
6
 
6
7
  set_id_name "wocs"
7
8
 
9
+ class NatSourceAddressSequence < IControl::Base::Sequence ; end
8
10
  # An enumeration of nat address states.
9
11
  class NatSourceAddress < IControl::Base::Enumeration; end ##
10
12
  # Create a local WOC object.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
13
+ # @rspec_example
14
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
15
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
16
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
17
  # @param [Hash] opts
15
18
  # @option opts [long] :woc_instance The local woc object id.
16
19
  # @option opts [String] :local_ips The local ip addresses.
@@ -23,105 +26,116 @@ module IControl::Networking
23
26
 
24
27
  ##
25
28
  # Delete the local WOC object.
26
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
27
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
28
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
29
+ # @rspec_example
30
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
31
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
32
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
29
33
  def delete_local
30
34
  super
31
35
  end
32
36
 
33
37
  ##
34
38
  # Get UUID
39
+ # @rspec_example
35
40
  # @return [Uuid_128]
36
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
37
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
38
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
41
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
42
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
43
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
39
44
  def UUID
40
45
  super
41
46
  end
42
47
 
43
48
  ##
44
49
  # Get the allow_nat attribute in the local WOC object.
50
+ # @rspec_example
45
51
  # @return [EnabledState]
46
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
47
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
48
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
52
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
49
55
  def allow_nat
50
56
  super
51
57
  end
52
58
 
53
59
  ##
54
60
  # Get enable setting in the local WOC object.
61
+ # @rspec_example
55
62
  # @return [EnabledState]
56
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
57
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
58
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
63
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
64
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
65
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
59
66
  def enabled_state
60
67
  super
61
68
  end
62
69
 
63
70
  ##
64
71
  # Get a list of the current WOC object names.
72
+ # @rspec_example
65
73
  # @return [String[]]
66
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
67
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
68
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
74
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
75
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
76
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
69
77
  def ip_list
70
78
  super
71
79
  end
72
80
 
73
81
  ##
74
82
  # Get a list of the current local endpoint object ids.
83
+ # @rspec_example
75
84
  # @return [long]
76
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
77
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
78
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
85
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
86
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
87
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
79
88
  def list
80
89
  super
81
90
  end
82
91
 
83
92
  ##
84
93
  # Get Management address
94
+ # @rspec_example
85
95
  # @return [String]
86
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
87
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
88
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
96
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
97
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
98
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
89
99
  def management_address
90
100
  super
91
101
  end
92
102
 
93
103
  ##
94
104
  # Gets the nat source address in the local WOC object.
105
+ # @rspec_example
95
106
  # @return [NatSourceAddress]
96
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
97
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
98
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
107
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
108
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
109
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
99
110
  def nat_source_address
100
111
  super
101
112
  end
102
113
 
103
114
  ##
104
115
  # Get serverssl name strings in the local WOC object(s).
116
+ # @rspec_example
105
117
  # @return [String]
106
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
107
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
108
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
118
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
119
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
120
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
109
121
  def serverssl
110
122
  super
111
123
  end
112
124
 
113
125
  ##
114
126
  # Get local port number in the local WOC object.
127
+ # @rspec_example
115
128
  # @return [long]
116
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
117
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
118
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
129
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
130
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
131
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
119
132
  def tunnel_port
120
133
  super
121
134
  end
122
135
 
123
136
  ##
124
137
  # Gets the version information for this interface.
138
+ # @rspec_example
125
139
  # @return [String]
126
140
  def version
127
141
  super
@@ -129,9 +143,10 @@ module IControl::Networking
129
143
 
130
144
  ##
131
145
  # Set the allow_nat attribute in the local WOC object.
132
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
133
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
134
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
146
+ # @rspec_example
147
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
148
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
149
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
135
150
  # @param [Hash] opts
136
151
  # @option opts [IControl::Common::EnabledState] :nat_states The new nat states.
137
152
  def set_allow_nat(opts)
@@ -141,9 +156,10 @@ module IControl::Networking
141
156
 
142
157
  ##
143
158
  # Set enable in the local WOC object.
144
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
145
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
146
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
159
+ # @rspec_example
160
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
161
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
162
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
147
163
  # @param [Hash] opts
148
164
  # @option opts [IControl::Common::EnabledState] :enabled_states The new enabled state flags.
149
165
  def set_enabled_state(opts)
@@ -153,9 +169,10 @@ module IControl::Networking
153
169
 
154
170
  ##
155
171
  # Set Management address
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.
172
+ # @rspec_example
173
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
174
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
175
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
159
176
  # @param [Hash] opts
160
177
  # @option opts [String] :ips The local ip addresses.
161
178
  def set_management_address(opts)
@@ -165,9 +182,10 @@ module IControl::Networking
165
182
 
166
183
  ##
167
184
  # Sets the nat source address in the local WOC object.
168
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
169
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
170
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
185
+ # @rspec_example
186
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
187
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
188
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
171
189
  # @param [Hash] opts
172
190
  # @option opts [IControl::Networking::iSessionLocalInterface::NatSourceAddress] :nat_states The new nat states.
173
191
  def set_nat_source_address(opts)
@@ -177,9 +195,10 @@ module IControl::Networking
177
195
 
178
196
  ##
179
197
  # Set serverssl string in the local WOC object.
180
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
181
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
182
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
198
+ # @rspec_example
199
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
200
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
201
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
183
202
  # @param [Hash] opts
184
203
  # @option opts [String] :serverssls The serverssl strings to be used.
185
204
  def set_serverssl(opts)
@@ -189,9 +208,10 @@ module IControl::Networking
189
208
 
190
209
  ##
191
210
  # Set local port number in the local WOC object.
192
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
193
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
194
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
211
+ # @rspec_example
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.
195
215
  # @param [Hash] opts
196
216
  # @option opts [long] :ports The new local port numbers.
197
217
  def set_tunnel_port(opts)