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
@@ -12,24 +12,37 @@ module IControl::Management
12
12
  class InstanceInfo < IControl::Base::Struct; end
13
13
  class InstanceVariable < IControl::Base::Struct; end
14
14
  class ModuleInfo < IControl::Base::Struct; end
15
+ class ClassInfoSequence < IControl::Base::Sequence ; end
16
+ class ClassTransactionInfoSequence < IControl::Base::Sequence ; end
17
+ class DeprecatedClassInfoSequence < IControl::Base::Sequence ; end
18
+ class InstanceInfoSequence < IControl::Base::Sequence ; end
19
+ class InstanceInfoSequenceSequence < IControl::Base::SequenceSequence ; end
20
+ class InstanceSequence < IControl::Base::Sequence ; end
21
+ class InstanceSequenceSequence < IControl::Base::SequenceSequence ; end
22
+ class InstanceVariableSequence < IControl::Base::Sequence ; end
23
+ class InstanceVariableSequenceSequence < IControl::Base::SequenceSequence ; end
24
+ class ModuleInfoSequence < IControl::Base::Sequence ; end
15
25
  # This enum defines instance format types.
16
26
  class InstanceFormatType < IControl::Base::Enumeration; end
17
27
  # This enum defines instance variable types.
18
28
  class InstanceVariableType < IControl::Base::Enumeration; end ##
19
29
  # Delete object instance
20
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
21
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
22
- # @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.
23
34
  def delete_instance
24
35
  super
25
36
  end
26
37
 
27
38
  ##
28
- # Gets the sequence of class information for the classes of objects available on the system
39
+ # Gets the sequence of class information for the classes of objects available on the
40
+ # system
41
+ # @rspec_example
29
42
  # @return [ClassInfo]
30
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
31
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
32
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
43
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
33
46
  # @param [Hash] opts
34
47
  # @option opts [String] :filter The filter to apply to the class names
35
48
  def class_info(opts)
@@ -38,11 +51,13 @@ module IControl::Management
38
51
  end
39
52
 
40
53
  ##
41
- # Gets the sequence of deprecated class information for the classes of objects that have been deprecated
54
+ # Gets the sequence of deprecated class information for the classes of objects that
55
+ # have been deprecated
56
+ # @rspec_example
42
57
  # @return [DeprecatedClassInfo]
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.
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.
46
61
  # @param [Hash] opts
47
62
  # @option opts [String] :filter The filter to apply to the class names
48
63
  def deprecated_class_info(opts)
@@ -52,10 +67,11 @@ module IControl::Management
52
67
 
53
68
  ##
54
69
  # Gets the information and contents of each instance requested
70
+ # @rspec_example
55
71
  # @return [Instance]
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.
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.
59
75
  # @param [Hash] opts
60
76
  # @option opts [IControl::Management::ChangeControl::InstanceFormatType] :instance_format The format of contents
61
77
  def instance(opts)
@@ -65,10 +81,11 @@ module IControl::Management
65
81
 
66
82
  ##
67
83
  # Gets the sequence of dependencies for each instance
84
+ # @rspec_example
68
85
  # @return [String[]]
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.
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.
72
89
  # @param [Hash] opts
73
90
  # @option opts [long] :depth Limits the depth of search. Zero indicates no limit.
74
91
  def instance_dependency(opts)
@@ -78,10 +95,11 @@ module IControl::Management
78
95
 
79
96
  ##
80
97
  # Gets the sequence of information for each instance of each class
98
+ # @rspec_example
81
99
  # @return [InstanceInfo[]]
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.
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.
85
103
  # @param [Hash] opts
86
104
  # @option opts [IControl::Management::ChangeControl::ClassTransactionInfo] :classes Class names and transaction information (tx = 0 indicates all instances)
87
105
  def instance_info(opts)
@@ -91,10 +109,11 @@ module IControl::Management
91
109
 
92
110
  ##
93
111
  # Gets the sequence of variable items for each instance
112
+ # @rspec_example
94
113
  # @return [InstanceVariable[]]
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.
114
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
115
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
116
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
98
117
  # @param [Hash] opts
99
118
  # @option opts [IControl::Management::ChangeControl::InstanceVariableType] :instance_variable The format of contents
100
119
  def instance_variable(opts)
@@ -104,20 +123,22 @@ module IControl::Management
104
123
 
105
124
  ##
106
125
  # Gets the last time that the configuration was loaded.
126
+ # @rspec_example
107
127
  # @return [TimeStamp]
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.
128
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
129
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
130
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
111
131
  def last_load_time
112
132
  super
113
133
  end
114
134
 
115
135
  ##
116
136
  # Gets the sequence of module information for the modules available on the system
137
+ # @rspec_example
117
138
  # @return [ModuleInfo]
118
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
119
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
120
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
139
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
140
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
141
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
121
142
  # @param [Hash] opts
122
143
  # @option opts [String] :filter The filter to apply to the module names
123
144
  def module_info(opts)
@@ -127,6 +148,7 @@ module IControl::Management
127
148
 
128
149
  ##
129
150
  # Gets the version information for this interface.
151
+ # @rspec_example
130
152
  # @return [String]
131
153
  def version
132
154
  super
@@ -134,9 +156,10 @@ module IControl::Management
134
156
 
135
157
  ##
136
158
  # Put object configuration (formatted contents)
137
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
138
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
139
- # @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.
140
163
  # @param [Hash] opts
141
164
  # @option opts [IControl::Management::ChangeControl::InstanceFormatType] :instance_format The instance format used in the data (same for all instances)
142
165
  # @option opts [String] :data Formatted configuration (collection of instance data)
@@ -147,9 +170,10 @@ module IControl::Management
147
170
 
148
171
  ##
149
172
  # Put object instance (native format)
150
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
151
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
152
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
173
+ # @rspec_example
174
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
175
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
176
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
153
177
  # @param [Hash] opts
154
178
  # @option opts [IControl::Management::ChangeControl::Instance] :instances The instances to put (transaction_id discarded)
155
179
  def put_instance(opts)
@@ -159,9 +183,10 @@ module IControl::Management
159
183
 
160
184
  ##
161
185
  # Verify object configuration (formatted contents) can be put/saved
162
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
163
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
164
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
186
+ # @rspec_example
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.
165
190
  # @param [Hash] opts
166
191
  # @option opts [IControl::Management::ChangeControl::InstanceFormatType] :instance_format The instance format used in the data (same for all instances)
167
192
  # @option opts [String] :data Formatted configuration (collection of instance data)
@@ -172,9 +197,10 @@ module IControl::Management
172
197
 
173
198
  ##
174
199
  # Verify that object instance (native format) can be put
175
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
176
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
177
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
200
+ # @rspec_example
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.
178
204
  # @param [Hash] opts
179
205
  # @option opts [IControl::Management::ChangeControl::Instance] :instances The instances to verify (transaction_id discarded)
180
206
  def verify_instance(opts)
@@ -7,9 +7,10 @@ module IControl::Management
7
7
 
8
8
  ##
9
9
  # Adds/associates servers to this CRLDP configurations.
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.
10
+ # @rspec_example
11
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
13
14
  # @param [Hash] opts
14
15
  # @option opts [String[]] :servers The servers to add to the CRLDP configurations.
15
16
  def add_server(opts)
@@ -19,9 +20,10 @@ module IControl::Management
19
20
 
20
21
  ##
21
22
  # Creates this CRLDP configurations.
22
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
23
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
24
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
25
27
  # @param [Hash] opts
26
28
  # @option opts [String[]] :servers The list of servers to be assigned to each of the configurations.
27
29
  def create(opts)
@@ -31,84 +33,95 @@ module IControl::Management
31
33
 
32
34
  ##
33
35
  # Deletes all CRLDP configurations.
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.
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.
37
40
  def delete_all_configurations
38
41
  super
39
42
  end
40
43
 
41
44
  ##
42
45
  # Deletes this CRLDP configurations.
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.
46
+ # @rspec_example
47
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
48
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
49
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
46
50
  def delete_configuration
47
51
  super
48
52
  end
49
53
 
50
54
  ##
51
- # Gets the number of seconds before a CRL entry expires and is deleted from the CRL cache.
55
+ # Gets the number of seconds before a CRL entry expires and is deleted from the CRL
56
+ # cache.
57
+ # @rspec_example
52
58
  # @return [long]
53
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
54
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
55
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
59
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
56
62
  def cache_timeout
57
63
  super
58
64
  end
59
65
 
60
66
  ##
61
- # Gets the number of seconds to wait for server's response before concluding that the server is down.
67
+ # Gets the number of seconds to wait for server's response before concluding that the
68
+ # server is down.
69
+ # @rspec_example
62
70
  # @return [long]
63
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
64
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
65
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
71
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
72
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
73
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
66
74
  def connection_timeout
67
75
  super
68
76
  end
69
77
 
70
78
  ##
71
79
  # Gets a list of all CRLDP configurations.
80
+ # @rspec_example
72
81
  # @return [String]
73
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
74
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
75
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
76
85
  def list
77
86
  super
78
87
  end
79
88
 
80
89
  ##
81
90
  # Gets the lists of servers this CRLDP configurations are associated with.
91
+ # @rspec_example
82
92
  # @return [String[]]
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.
93
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
94
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
95
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
86
96
  def server
87
97
  super
88
98
  end
89
99
 
90
100
  ##
91
101
  # Gets the number of seconds to wait between updates.
102
+ # @rspec_example
92
103
  # @return [long]
93
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
94
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
95
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
104
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
105
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
106
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
96
107
  def update_interval
97
108
  super
98
109
  end
99
110
 
100
111
  ##
101
112
  # Gets the states indicating whether reuse the issuer.
113
+ # @rspec_example
102
114
  # @return [EnabledState]
103
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
104
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
105
- # @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.
106
118
  def use_issuer_state
107
119
  super
108
120
  end
109
121
 
110
122
  ##
111
123
  # Gets the version information for this interface.
124
+ # @rspec_example
112
125
  # @return [String]
113
126
  def version
114
127
  super
@@ -116,18 +129,20 @@ module IControl::Management
116
129
 
117
130
  ##
118
131
  # Removes all servers from this CRLDP configurations.
119
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
120
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
121
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
132
+ # @rspec_example
133
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
134
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
135
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
122
136
  def remove_all_servers
123
137
  super
124
138
  end
125
139
 
126
140
  ##
127
141
  # Removes servers from this CRLDP configurations.
128
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
129
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
130
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
142
+ # @rspec_example
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.
131
146
  # @param [Hash] opts
132
147
  # @option opts [String[]] :servers The servers to remove from the CRLDP configurations.
133
148
  def remove_server(opts)
@@ -136,10 +151,12 @@ module IControl::Management
136
151
  end
137
152
 
138
153
  ##
139
- # Sets the number of seconds before a CRL entry expires and is deleted from the CRL cache.
140
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
141
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
142
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
154
+ # Sets the number of seconds before a CRL entry expires and is deleted from the CRL
155
+ # cache.
156
+ # @rspec_example
157
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
158
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
159
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
143
160
  # @param [Hash] opts
144
161
  # @option opts [long] :timeouts The timeouts used by the configurations.
145
162
  def set_cache_timeout(opts)
@@ -148,10 +165,12 @@ module IControl::Management
148
165
  end
149
166
 
150
167
  ##
151
- # Sets the number of seconds to wait for server's response before concluding that the server is down.
152
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
153
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
154
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
168
+ # Sets the number of seconds to wait for server's response before concluding that the
169
+ # server is down.
170
+ # @rspec_example
171
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
172
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
173
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
155
174
  # @param [Hash] opts
156
175
  # @option opts [long] :timeouts The connection timeouts used by the configurations.
157
176
  def set_connection_timeout(opts)
@@ -161,9 +180,10 @@ module IControl::Management
161
180
 
162
181
  ##
163
182
  # Sets the number of seconds to wait between updates.
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.
183
+ # @rspec_example
184
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
185
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
186
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
167
187
  # @param [Hash] opts
168
188
  # @option opts [long] :intervals The update intervals used by the configurations.
169
189
  def set_update_interval(opts)
@@ -173,9 +193,10 @@ module IControl::Management
173
193
 
174
194
  ##
175
195
  # Sets the states indicating whether to reuse the issuer.
176
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
177
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
178
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
196
+ # @rspec_example
197
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
198
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
199
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
179
200
  # @param [Hash] opts
180
201
  # @option opts [IControl::Common::EnabledState] :states The states of the specified configurations.
181
202
  def set_use_issuer_state(opts)
@@ -5,85 +5,96 @@ module IControl::Management
5
5
 
6
6
  set_id_name "servers"
7
7
 
8
- class CRLDPServerDefinition < IControl::Base::Struct; end ##
8
+ class CRLDPServerDefinition < IControl::Base::Struct; end
9
+ class CRLDPServerDefinitionSequence < IControl::Base::Sequence ; end ##
9
10
  # Creates this CRLDP server.
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.
11
+ # @rspec_example
12
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
13
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
14
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
13
15
  def create
14
16
  super
15
17
  end
16
18
 
17
19
  ##
18
20
  # Deletes all CRLDP server.
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.
21
+ # @rspec_example
22
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
23
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
24
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
22
25
  def delete_all_servers
23
26
  super
24
27
  end
25
28
 
26
29
  ##
27
30
  # Deletes this CRLDP server.
28
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
29
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
30
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
31
+ # @rspec_example
32
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
33
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
34
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
31
35
  def delete_server
32
36
  super
33
37
  end
34
38
 
35
39
  ##
36
40
  # Gets the base DNs of the CRLDP server.
41
+ # @rspec_example
37
42
  # @return [String]
38
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
39
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
40
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
43
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
41
46
  def base_dn
42
47
  super
43
48
  end
44
49
 
45
50
  ##
46
51
  # Gets the hostnames of the CRLDP server.
52
+ # @rspec_example
47
53
  # @return [String]
48
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
- # @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.
51
57
  def hostname
52
58
  super
53
59
  end
54
60
 
55
61
  ##
56
62
  # Gets a list of all CRLDP server.
63
+ # @rspec_example
57
64
  # @return [String]
58
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
59
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
60
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
65
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
66
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
67
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
61
68
  def list
62
69
  super
63
70
  end
64
71
 
65
72
  ##
66
73
  # Gets the ports of the CRLDP server.
74
+ # @rspec_example
67
75
  # @return [long]
68
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
69
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
70
- # @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.
71
79
  def port
72
80
  super
73
81
  end
74
82
 
75
83
  ##
76
- # Gets the states indicating whether to match from head to tail in the case where the DNs are in reversed order.
84
+ # Gets the states indicating whether to match from head to tail in the case where the
85
+ # DNs are in reversed order.
86
+ # @rspec_example
77
87
  # @return [EnabledState]
78
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
79
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
80
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
88
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
89
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
90
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
81
91
  def reverse_dn_state
82
92
  super
83
93
  end
84
94
 
85
95
  ##
86
96
  # Gets the version information for this interface.
97
+ # @rspec_example
87
98
  # @return [String]
88
99
  def version
89
100
  super
@@ -91,9 +102,10 @@ module IControl::Management
91
102
 
92
103
  ##
93
104
  # Sets the base DNs of the CRLDP server.
94
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
95
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
96
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
105
+ # @rspec_example
106
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
107
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
108
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
97
109
  # @param [Hash] opts
98
110
  # @option opts [String] :base_dns The base DNs used by the servers.
99
111
  def set_base_dn(opts)
@@ -103,9 +115,10 @@ module IControl::Management
103
115
 
104
116
  ##
105
117
  # Sets the hostnames of the CRLDP server.
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
+ # @rspec_example
119
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
120
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
121
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
109
122
  # @param [Hash] opts
110
123
  # @option opts [String] :hostnames The hostnames used by the servers.
111
124
  def set_hostname(opts)
@@ -115,9 +128,10 @@ module IControl::Management
115
128
 
116
129
  ##
117
130
  # Sets the ports of the CRLDP server.
118
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
119
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
120
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
131
+ # @rspec_example
132
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
133
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
134
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
121
135
  # @param [Hash] opts
122
136
  # @option opts [long] :ports The ports used by the servers.
123
137
  def set_port(opts)
@@ -126,10 +140,12 @@ module IControl::Management
126
140
  end
127
141
 
128
142
  ##
129
- # Sets the states indicating whether to match from head to tail in the case where the DNs are in reversed order.
130
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
131
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
132
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
143
+ # Sets the states indicating whether to match from head to tail in the case where the
144
+ # DNs are in reversed order.
145
+ # @rspec_example
146
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
147
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
148
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
133
149
  # @param [Hash] opts
134
150
  # @option opts [IControl::Common::EnabledState] :states The states to set.
135
151
  def set_reverse_dn_state(opts)