icontrol 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -1,40 +1,47 @@
1
1
  module IControl::Management
2
2
  ##
3
- # The DBVariable interface exposes methods that enable you to work directly with our internal database that contains configuration variables using name/value pairs.
3
+ # The DBVariable interface exposes methods that enable you to work directly with our
4
+ # internal database that contains configuration variables using name/value pairs.
4
5
  class DBVariable < IControl::Base
5
6
 
6
7
  set_id_name "variables"
7
8
 
8
- class VariableNameValue < IControl::Base::Struct; end ##
9
+ class VariableNameValue < IControl::Base::Struct; end
10
+ class VariableNameValueSequence < IControl::Base::Sequence ; end ##
9
11
  # Creates this variable in the database.
10
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
11
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
12
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
12
+ # @rspec_example
13
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
14
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
15
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
13
16
  def create
14
17
  super
15
18
  end
16
19
 
17
20
  ##
18
21
  # Deletes the variable referenced from the database.
19
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
20
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
21
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
22
+ # @rspec_example
23
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
24
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
25
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
22
26
  def delete_variable
23
27
  super
24
28
  end
25
29
 
26
30
  ##
27
- # Retrieves the values of all variable defined in the database. This list can potentially be huge.
31
+ # Retrieves the values of all variable defined in the database. This list can potentially
32
+ # be huge.
33
+ # @rspec_example
28
34
  # @return [VariableNameValue]
29
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
30
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
31
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
35
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
36
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
37
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
32
38
  def list
33
39
  super
34
40
  end
35
41
 
36
42
  ##
37
43
  # Gets the version information for this interface.
44
+ # @rspec_example
38
45
  # @return [String]
39
46
  def version
40
47
  super
@@ -42,35 +49,39 @@ module IControl::Management
42
49
 
43
50
  ##
44
51
  # Verifies the existence of this variable in the database.
52
+ # @rspec_example
45
53
  # @return [boolean]
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.
54
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
55
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
56
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
49
57
  def is_variable_available
50
58
  super
51
59
  end
52
60
 
53
61
  ##
54
62
  # Modifies this variable in the database.
63
+ # @rspec_example
55
64
  def modify
56
65
  super
57
66
  end
58
67
 
59
68
  ##
60
69
  # Queries the values of this variable.
70
+ # @rspec_example
61
71
  # @return [VariableNameValue]
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 query
66
76
  super
67
77
  end
68
78
 
69
79
  ##
70
80
  # Resets this variable to their default values.
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.
81
+ # @rspec_example
82
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
83
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
84
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
74
85
  def reset
75
86
  super
76
87
  end
@@ -1,6 +1,7 @@
1
1
  module IControl::Management
2
2
  ##
3
- # The EventNotification interface is used for system configuration change events that are configured with the EventSubscriptions interface.
3
+ # The EventNotification interface is used for system configuration change events that
4
+ # are configured with the EventSubscriptions interface.
4
5
  class EventNotification < IControl::Base
5
6
 
6
7
  set_id_name "event_source"
@@ -8,9 +9,16 @@ module IControl::Management
8
9
  class EventData < IControl::Base::Struct; end
9
10
  class EventDataItem < IControl::Base::Struct; end
10
11
  class EventSource < IControl::Base::Struct; end
11
- # The EventDataType enum contains the supported data types in a valid notification message.
12
+ class EventDataItemSequence < IControl::Base::Sequence ; end
13
+ class EventDataSequence < IControl::Base::Sequence ; end
14
+ class EventDataTypeSequence < IControl::Base::Sequence ; end
15
+ class EventSourceSequence < IControl::Base::Sequence ; end
16
+ # The EventDataType enum contains the supported data types in a valid notification
17
+ # message.
12
18
  class EventDataType < IControl::Base::Enumeration; end ##
13
- # The notification mechanism used to send event notification messages. Clients must implement this interface to act as an endpoint of event notifications.
19
+ # The notification mechanism used to send event notification messages. Clients must
20
+ # implement this interface to act as an endpoint of event notifications.
21
+ # @rspec_example
14
22
  # @param [Hash] opts
15
23
  # @option opts [String] :subscription_id The subscription that this message was sent on behalf of.
16
24
  # @option opts [IControl::Management::EventNotification::EventData] :event_data_list A list of EventData notifications.
@@ -21,18 +29,19 @@ module IControl::Management
21
29
  end
22
30
 
23
31
  ##
24
- # Event notifications are sent as a sequence of EventData structures. Each EventData structure represents a single data object that changed.
32
+ # Event notifications are sent as a sequence of EventData structures. Each EventData
33
+ # structure represents a single data object that changed.
25
34
  # @attr [String] username The user who initiated the change.
26
35
  # @attr [Numeric] sequence_number The sequence number is a persisted value that will increment by one for each event notification message configured to be sent to the notification endpoint.
27
36
  # @attr [IControl::Management::EventSubscription::EventType] event_type The type of event that triggered the notification.
28
37
  # @attr [IControl::Management::EventSubscription::ObjectType] object_type The object type specified in this notification.
29
- # @attr [IControl::Management::EventNotification::EventDataItem] event_data_item_list The list of the objects attributes that changed.
38
+ # @attr [IControl::Management::EventNotification::EventDataItemSequence] event_data_item_list The list of the objects attributes that changed.
30
39
  class EventData < IControl::Base::Struct
31
40
  icontrol_attribute :username, String
32
41
  icontrol_attribute :sequence_number, Numeric
33
42
  icontrol_attribute :event_type, IControl::Management::EventSubscription::EventType
34
43
  icontrol_attribute :object_type, IControl::Management::EventSubscription::ObjectType
35
- icontrol_attribute :event_data_item_list, IControl::Management::EventNotification::EventDataItem
44
+ icontrol_attribute :event_data_item_list, IControl::Management::EventNotification::EventDataItemSequence
36
45
  end
37
46
 
38
47
  ##
@@ -47,7 +56,8 @@ module IControl::Management
47
56
  end
48
57
 
49
58
  ##
50
- # The identification of the event notification source. This will be the identification of the F5 device that sent the notification.
59
+ # The identification of the event notification source. This will be the identification
60
+ # of the F5 device that sent the notification.
51
61
  # @attr [String] system_id The system identifier for the source of the event.
52
62
  # @attr [String] url The management url for the source of the event.
53
63
  class EventSource < IControl::Base::Struct
@@ -64,7 +74,8 @@ module IControl::Management
64
74
  class EventDataTypeSequence < IControl::Base::Sequence ; end
65
75
  ## A Sequence of EventDataSource structures.
66
76
  class EventSourceSequence < IControl::Base::Sequence ; end
67
- # The EventDataType enum contains the supported data types in a valid notification message.
77
+ # The EventDataType enum contains the supported data types in a valid notification
78
+ # message.
68
79
  class EventDataType < IControl::Base::Enumeration
69
80
  # A hexadecimal string representing a sequence of bits.
70
81
  DATATYPE_BITS = :DATATYPE_BITS
@@ -1,6 +1,7 @@
1
1
  module IControl::Management
2
2
  ##
3
- # The EventSubscription interface is to be used to register for system configuration change events. Events are sent using the EventNotification interface.
3
+ # The EventSubscription interface is to be used to register for system configuration
4
+ # change events. Events are sent using the EventNotification interface.
4
5
  class EventSubscription < IControl::Base
5
6
 
6
7
  set_id_name "id_list"
@@ -10,19 +11,31 @@ module IControl::Management
10
11
  class SubscriptionStatistics < IControl::Base::Struct; end
11
12
  class SubscriptionStatus < IControl::Base::Struct; end
12
13
  class UserCredential < IControl::Base::Struct; end
14
+ class AuthenticationModeSequence < IControl::Base::Sequence ; end
15
+ class EventTypeSequence < IControl::Base::Sequence ; end
16
+ class ObjectTypeSequence < IControl::Base::Sequence ; end
17
+ class SubscriptionDefinitionSequence < IControl::Base::Sequence ; end
18
+ class SubscriptionDetailsSequence < IControl::Base::Sequence ; end
19
+ class SubscriptionStatisticsSequence < IControl::Base::Sequence ; end
20
+ class SubscriptionStatusCodeSequence < IControl::Base::Sequence ; end
21
+ class SubscriptionStatusSequence < IControl::Base::Sequence ; end
22
+ class UserCredentialSequence < IControl::Base::Sequence ; end
13
23
  # The authentication modes used for http(s) based communications.
14
24
  class AuthenticationMode < IControl::Base::Enumeration; end
15
- # The category event that a given subscription is listening on. when the subscription sees an event occur that fits one of these flags, a notification is triggered.
25
+ # The category event that a given subscription is listening on. when the subscription
26
+ # sees an event occur that fits one of these flags, a notification is triggered.
16
27
  class EventType < IControl::Base::Enumeration; end
17
28
  # The object types that are included in a event notification event.
18
29
  class ObjectType < IControl::Base::Enumeration; end
19
30
  # Status codes specific to the EventSubscription interface.
20
31
  class SubscriptionStatusCode < IControl::Base::Enumeration; end ##
21
- # Create a new subscription. This takes an an input a list of subscription details, one for each subscription requested.
32
+ # Create a new subscription. This takes an an input a list of subscription details,
33
+ # one for each subscription requested.
34
+ # @rspec_example
22
35
  # @return [SubscriptionStatus]
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.
36
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
37
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
38
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
26
39
  # @param [Hash] opts
27
40
  # @option opts [IControl::Management::EventSubscription::SubscriptionDetails] :sub_detail_list A list of subscription details with the configuration of the requested subscription.
28
41
  def create(opts)
@@ -32,30 +45,34 @@ module IControl::Management
32
45
 
33
46
  ##
34
47
  # Retrieve a list of event types available on this system.
48
+ # @rspec_example
35
49
  # @return [EventType]
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.
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.
39
53
  def available_event_types
40
54
  super
41
55
  end
42
56
 
43
57
  ##
44
58
  # Retrieve the list of configured subscription identifiers.
59
+ # @rspec_example
45
60
  # @return [String]
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.
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.
49
64
  def list
50
65
  super
51
66
  end
52
67
 
53
68
  ##
54
- # Get the maximum timeslice (in seconds) between event notifications for the list of subscription identifiers.
69
+ # Get the maximum timeslice (in seconds) between event notifications for the list of
70
+ # subscription identifiers.
71
+ # @rspec_example
55
72
  # @return [SubscriptionStatus]
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.
73
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
74
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
75
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
59
76
  # @param [Hash] opts
60
77
  # @option opts [long] :max_timeslice_list A list of maximum timeslice values corresponding to the given list of subscriptions identifiers.
61
78
  def max_timeslice(opts)
@@ -65,10 +82,11 @@ module IControl::Management
65
82
 
66
83
  ##
67
84
  # Get the minimum number of events needed to trigger a notification message.
85
+ # @rspec_example
68
86
  # @return [SubscriptionStatus]
69
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
70
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
71
- # @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.
72
90
  # @param [Hash] opts
73
91
  # @option opts [long] :min_events_list A list of minimum event values corresponding to the given list of subscription identifiers.
74
92
  def min_events_per_timeslice(opts)
@@ -78,10 +96,11 @@ module IControl::Management
78
96
 
79
97
  ##
80
98
  # Get the enabled state of a list of subscription identifiers.
99
+ # @rspec_example
81
100
  # @return [SubscriptionStatus]
82
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
83
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
84
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
85
104
  # @param [Hash] opts
86
105
  # @option opts [IControl::Common::EnabledState] :state_list The enabled states corresponding to the input list of subscription identifiers.
87
106
  def state(opts)
@@ -91,10 +110,11 @@ module IControl::Management
91
110
 
92
111
  ##
93
112
  # Get the statistics for the given list of subscription identifiers.
113
+ # @rspec_example
94
114
  # @return [SubscriptionStatus]
95
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
96
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
97
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
98
118
  # @param [Hash] opts
99
119
  # @option opts [IControl::Management::EventSubscription::SubscriptionStatistics] :statistics_list A list of statistics associated with the given list of subscription identifiers.
100
120
  def statistics(opts)
@@ -104,10 +124,11 @@ module IControl::Management
104
124
 
105
125
  ##
106
126
  # Get the time to live (ttl) in seconds for the list of subscription identifiers.
127
+ # @rspec_example
107
128
  # @return [SubscriptionStatus]
108
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
109
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
110
- # @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.
111
132
  # @param [Hash] opts
112
133
  # @option opts [long] :ttl_list A list of ttl values associated with the given subscription identifiers.
113
134
  def ttl(opts)
@@ -117,10 +138,11 @@ module IControl::Management
117
138
 
118
139
  ##
119
140
  # Get the url endpoint that implements the EventNotification interface.
141
+ # @rspec_example
120
142
  # @return [SubscriptionStatus]
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.
143
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
144
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
145
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
124
146
  # @param [Hash] opts
125
147
  # @option opts [String] :url_list The list of url's corresponding to the input list of subscription identifiers.
126
148
  def url(opts)
@@ -130,17 +152,20 @@ module IControl::Management
130
152
 
131
153
  ##
132
154
  # Gets the version information for this interface.
155
+ # @rspec_example
133
156
  # @return [String]
134
157
  def version
135
158
  super
136
159
  end
137
160
 
138
161
  ##
139
- # Modify a list of subscriptions. This takes a list of subscription definitions representing the subscriptions that are to be modified.
162
+ # Modify a list of subscriptions. This takes a list of subscription definitions representing
163
+ # the subscriptions that are to be modified.
164
+ # @rspec_example
140
165
  # @return [SubscriptionStatus]
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.
166
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
167
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
168
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
144
169
  # @param [Hash] opts
145
170
  # @option opts [IControl::Management::EventSubscription::SubscriptionDefinition] :sub_def_list A list of subscription definitions that are to be modified.
146
171
  def modify(opts)
@@ -150,20 +175,22 @@ module IControl::Management
150
175
 
151
176
  ##
152
177
  # A lightweight ping to determine the event notification service's health.
178
+ # @rspec_example
153
179
  # @return [SubscriptionStatus]
154
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
155
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
156
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
180
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
181
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
182
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
157
183
  def ping
158
184
  super
159
185
  end
160
186
 
161
187
  ##
162
188
  # Retrieve the subscription definitions for a list of subscription identifiers.
189
+ # @rspec_example
163
190
  # @return [SubscriptionStatus]
164
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
165
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
166
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
191
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
192
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
193
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
167
194
  # @param [Hash] opts
168
195
  # @option opts [IControl::Management::EventSubscription::SubscriptionDefinition] :sub_def_list The output results for the list of subscription identifiers.
169
196
  def query(opts)
@@ -172,31 +199,37 @@ module IControl::Management
172
199
  end
173
200
 
174
201
  ##
175
- # Remove a list of subscriptions. This takes as input a list of subscription id's and returns a list of status structures with the associated status code for each item in the id_list.
202
+ # Remove a list of subscriptions. This takes as input a list of subscription id's and
203
+ # returns a list of status structures with the associated status code for each item
204
+ # in the id_list.
205
+ # @rspec_example
176
206
  # @return [SubscriptionStatus]
177
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
178
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
179
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
207
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
208
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
209
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
180
210
  def remove
181
211
  super
182
212
  end
183
213
 
184
214
  ##
185
215
  # Reset the statistics for the given list of subscription identifiers.
216
+ # @rspec_example
186
217
  # @return [SubscriptionStatus]
187
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
188
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
189
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
218
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
219
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
220
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
190
221
  def reset_statistics
191
222
  super
192
223
  end
193
224
 
194
225
  ##
195
- # Set the credentials for the url's associated with the given list of subscription identifiers.
226
+ # Set the credentials for the url's associated with the given list of subscription
227
+ # identifiers.
228
+ # @rspec_example
196
229
  # @return [SubscriptionStatus]
197
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
198
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
199
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
230
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
231
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
232
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
200
233
  # @param [Hash] opts
201
234
  # @option opts [IControl::Management::EventSubscription::UserCredential] :credential_list The list of credentials to associate with the url's of the given list of subscription identifiers.
202
235
  def set_authentication(opts)
@@ -205,11 +238,14 @@ module IControl::Management
205
238
  end
206
239
 
207
240
  ##
208
- # Set the maximum timeslice (in seconds) between event notifications. This value is used to ensure that notifications are sent despite the minimum event attribute not reaching its threashold.
241
+ # Set the maximum timeslice (in seconds) between event notifications. This value is
242
+ # used to ensure that notifications are sent despite the minimum event attribute not
243
+ # reaching its threashold.
244
+ # @rspec_example
209
245
  # @return [SubscriptionStatus]
210
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
211
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
212
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
246
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
247
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
248
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
213
249
  # @param [Hash] opts
214
250
  # @option opts [long] :max_timeslice_list A list of maximum timeslice (in seconds) to be applied to the given subscription identifier.
215
251
  def set_max_timeslice(opts)
@@ -218,11 +254,14 @@ module IControl::Management
218
254
  end
219
255
 
220
256
  ##
221
- # Set the minimum number of events needed to trigger a notification message. This value is used to force a notification message to occur even if the max timeslice attribute is not reached yet.
257
+ # Set the minimum number of events needed to trigger a notification message. This value
258
+ # is used to force a notification message to occur even if the max timeslice attribute
259
+ # is not reached yet.
260
+ # @rspec_example
222
261
  # @return [SubscriptionStatus]
223
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
224
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
225
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
262
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
263
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
264
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
226
265
  # @param [Hash] opts
227
266
  # @option opts [long] :min_events_list A list of minimum event values to be applied to the given subscription identifiers.
228
267
  def set_min_events_per_timeslice(opts)
@@ -232,10 +271,11 @@ module IControl::Management
232
271
 
233
272
  ##
234
273
  # Set the enabled state of a list of subscriptions identifiers
274
+ # @rspec_example
235
275
  # @return [SubscriptionStatus]
236
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
237
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
238
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
276
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
277
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
278
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
239
279
  # @param [Hash] opts
240
280
  # @option opts [IControl::Common::EnabledState] :state_list The enabled states to set the list of subscription ids. These must match the id_list array.
241
281
  def set_state(opts)
@@ -245,10 +285,11 @@ module IControl::Management
245
285
 
246
286
  ##
247
287
  # Set the time to live (ttl) in seconds for the list of subscription identifiers.
288
+ # @rspec_example
248
289
  # @return [SubscriptionStatus]
249
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
250
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
251
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
290
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
291
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
292
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
252
293
  # @param [Hash] opts
253
294
  # @option opts [long] :ttl_list A list of ttl values for the given subscription identifiers. A value of -1 indicates an infinite lifetime.
254
295
  def set_ttl(opts)
@@ -258,10 +299,11 @@ module IControl::Management
258
299
 
259
300
  ##
260
301
  # Set the url endpoint that implements the EventNotification interface.
302
+ # @rspec_example
261
303
  # @return [SubscriptionStatus]
262
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
263
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
264
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
304
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
305
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
306
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
265
307
  # @param [Hash] opts
266
308
  # @option opts [String] :url_list The list of url's corresponding to the input list of subscription identifiers.
267
309
  def set_url(opts)
@@ -270,7 +312,8 @@ module IControl::Management
270
312
  end
271
313
 
272
314
  ##
273
- # A subscription definition. This includes a subscription identifier and the subscription details.
315
+ # A subscription definition. This includes a subscription identifier and the subscription
316
+ # details.
274
317
  # @attr [String] id A unique identifier for the subscription in the form of a GUID.
275
318
  # @attr [IControl::Management::EventSubscription::SubscriptionDetails] details The configuration details of the given subscription id.
276
319
  class SubscriptionDefinition < IControl::Base::Struct
@@ -279,9 +322,12 @@ module IControl::Management
279
322
  end
280
323
 
281
324
  ##
282
- # The configuration of a specific Event Subscription. This includes the name, registered events, the enabled state, and delivery configuration values. Event messages will be queued up and sent in a bulk manner as described by the min_events_per_timeslice and max_timeslice variables.
325
+ # The configuration of a specific Event Subscription. This includes the name, registered
326
+ # events, the enabled state, and delivery configuration values. Event messages will
327
+ # be queued up and sent in a bulk manner as described by the min_events_per_timeslice
328
+ # and max_timeslice variables.
283
329
  # @attr [String] name A user friendly name for the subscription.
284
- # @attr [IControl::Management::EventSubscription::EventType] event_type_list A list of event types to be notified of.
330
+ # @attr [IControl::Management::EventSubscription::EventTypeSequence] event_type_list A list of event types to be notified of.
285
331
  # @attr [String] url The url endpoint for the EventNotification inteface to receive event notifications.
286
332
  # @attr [IControl::Management::EventSubscription::UserCredential] url_credentials The credenials for the url endpoint.
287
333
  # @attr [Numeric] ttl The time to live (in seconds) for this subscription. After the ttl is reached, the subscription will be removed from the system. A value of -1 indicates an infinite life time.
@@ -290,7 +336,7 @@ module IControl::Management
290
336
  # @attr [IControl::Common::EnabledState] enabled_state Whether the subscription is enabled or disabled.
291
337
  class SubscriptionDetails < IControl::Base::Struct
292
338
  icontrol_attribute :name, String
293
- icontrol_attribute :event_type_list, IControl::Management::EventSubscription::EventType
339
+ icontrol_attribute :event_type_list, IControl::Management::EventSubscription::EventTypeSequence
294
340
  icontrol_attribute :url, String
295
341
  icontrol_attribute :url_credentials, IControl::Management::EventSubscription::UserCredential
296
342
  icontrol_attribute :ttl, Numeric
@@ -364,7 +410,8 @@ module IControl::Management
364
410
  end
365
411
 
366
412
 
367
- # The category event that a given subscription is listening on. when the subscription sees an event occur that fits one of these flags, a notification is triggered.
413
+ # The category event that a given subscription is listening on. when the subscription
414
+ # sees an event occur that fits one of these flags, a notification is triggered.
368
415
  class EventType < IControl::Base::Enumeration
369
416
  # Non event based message.
370
417
  EVENTTYPE_NONE = :EVENTTYPE_NONE