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,33 +1,42 @@
1
1
  module IControl::Management
2
2
  ##
3
- # The Partition interface enables you to manage AuthZ Administrative Partitions, as well as relationship between users, roles, and their associated partitions.
3
+ # The Partition interface enables you to manage AuthZ Administrative Partitions, as
4
+ # well as relationship between users, roles, and their associated partitions.
4
5
  class Partition < IControl::Base
5
6
 
6
7
  set_id_name "partitions"
7
8
 
8
- class AuthZPartition < IControl::Base::Struct; end ##
9
+ class AuthZPartition < IControl::Base::Struct; end
10
+ class AuthZPartitionSequence < IControl::Base::Sequence ; end ##
9
11
  # Creates this AuthZ partition.
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_partition
14
17
  super
15
18
  end
16
19
 
17
20
  ##
18
21
  # Deletes all AuthZ partition, except for the &amp;quot;Common" partition.
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_all_partitions
23
27
  super
24
28
  end
25
29
 
26
30
  ##
27
- # Deletes this AuthZ partition. It's recommended that if a partition to be deleted is also the current active partition, the user should change the active partition to something else first (using set_active_partition). Otherwise, in the event that the partition to be deleted is the current active partition, iControl will automatically default the new active partition to the &amp;quot;Common" partition.
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
+ # Deletes this AuthZ partition. It's recommended that if a partition to be deleted
32
+ # is also the current active partition, the user should change the active partition
33
+ # to something else first (using set_active_partition). Otherwise, in the event that
34
+ # the partition to be deleted is the current active partition, iControl will automatically
35
+ # default the new active partition to the &amp;quot;Common" partition.
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.
31
40
  # @param [Hash] opts
32
41
  # @option opts [String] :partition_names The names of the AuthZ partitions to delete.
33
42
  def delete_partition(opts)
@@ -36,37 +45,47 @@ module IControl::Management
36
45
  end
37
46
 
38
47
  ##
39
- # Gets the active partition for the current user. The active partition is the administrative partition where all configuration will take place until a new active partition is selected. Each user can only be in one active partition at any given time. By default, if not explicitly set, the active partition for a user will be &amp;quot;Common".
48
+ # Gets the active partition for the current user. The active partition is the administrative
49
+ # partition where all configuration will take place until a new active partition is
50
+ # selected. Each user can only be in one active partition at any given time. By default,
51
+ # if not explicitly set, the active partition for a user will be &amp;quot;Common".
52
+ # @rspec_example
40
53
  # @return [String]
41
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
42
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
43
- # @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.
44
57
  def active_partition
45
58
  super
46
59
  end
47
60
 
48
61
  ##
49
62
  # Gets a list of all AuthZ partition.
63
+ # @rspec_example
50
64
  # @return [AuthZPartition]
51
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
52
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
53
- # @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.
54
68
  def partition_list
55
69
  super
56
70
  end
57
71
 
58
72
  ##
59
73
  # Gets the version information for this interface.
74
+ # @rspec_example
60
75
  # @return [String]
61
76
  def version
62
77
  super
63
78
  end
64
79
 
65
80
  ##
66
- # Sets the active partition for the current user. The active partition is the administrative partition where all configuration will take place until a new active partition is selected. Each user can only be in one active partition at any given time. By default, if not explicitly set, the active partition for a user will be &amp;quot;Common".
67
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
68
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
69
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
81
+ # Sets the active partition for the current user. The active partition is the administrative
82
+ # partition where all configuration will take place until a new active partition is
83
+ # selected. Each user can only be in one active partition at any given time. By default,
84
+ # if not explicitly set, the active partition for a user will be &amp;quot;Common".
85
+ # @rspec_example
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.
70
89
  # @param [Hash] opts
71
90
  # @option opts [String] :active_partition The active partition to set.
72
91
  def set_active_partition(opts)
@@ -1,83 +1,107 @@
1
1
  module IControl::Management
2
2
  ##
3
- # The Provision interface manages the partitioning of system memory, disk space, and CPU usage among the modules (e.g., LTM, GTM, WOM) licensed to run on the system. The modules and the &amp;quot;host" system (everything not dedicated to network traffic processing) are first assigned a minimal set of resources, based on pre-determined values and the available system memory. The remaining resources are distributed among the modules, according to pre-determined rules, which can be modified by values which can be set via this iControl interface. The pre-defined module resource allocation handles a wide variety of circumstances, so this allocation should only need to be changed for unusual circumstances, such as turning modules on or off and large network traffic or configurations.
3
+ # The Provision interface manages the partitioning of system memory, disk space, and
4
+ # CPU usage among the modules (e.g., LTM, GTM, WOM) licensed to run on the system.
5
+ # The modules and the &amp;quot;host" system (everything not dedicated to network traffic
6
+ # processing) are first assigned a minimal set of resources, based on pre-determined
7
+ # values and the available system memory. The remaining resources are distributed among
8
+ # the modules, according to pre-determined rules, which can be modified by values which
9
+ # can be set via this iControl interface. The pre-defined module resource allocation
10
+ # handles a wide variety of circumstances, so this allocation should only need to be
11
+ # changed for unusual circumstances, such as turning modules on or off and large network
12
+ # traffic or configurations.
4
13
  class Provision < IControl::Base
5
14
 
6
15
  set_id_name "modules"
7
16
 
17
+ class ProvisionLevelSequence < IControl::Base::Sequence ; end
8
18
  # module provisioning levels
9
19
  class ProvisionLevel < IControl::Base::Enumeration; end ##
10
- # Gets the ratios of CPU usage above the minimum which are allocated to the requested module. This value is only meaningful for the &amp;quot;custom" provisioning level.
20
+ # Gets the ratios of CPU usage above the minimum which are allocated to the requested
21
+ # module. This value is only meaningful for the &amp;quot;custom" provisioning level.
22
+ # @rspec_example
11
23
  # @return [long]
12
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
13
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
14
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
15
27
  def custom_cpu_ratio
16
28
  super
17
29
  end
18
30
 
19
31
  ##
20
- # Gets the ratios of disk space above the minimum which are allocated to the requested module. This value is only meaningful for the &amp;quot;custom" provisioning level.
32
+ # Gets the ratios of disk space above the minimum which are allocated to the requested
33
+ # module. This value is only meaningful for the &amp;quot;custom" provisioning level.
34
+ # @rspec_example
21
35
  # @return [long]
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.
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.
25
39
  def custom_disk_ratio
26
40
  super
27
41
  end
28
42
 
29
43
  ##
30
- # Gets the ratios of system memory which are allocated to the requested module. This value is only meaningful for the &amp;quot;custom" provisioning level.
44
+ # Gets the ratios of system memory which are allocated to the requested module. This
45
+ # value is only meaningful for the &amp;quot;custom" provisioning level.
46
+ # @rspec_example
31
47
  # @return [long]
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.
48
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
35
51
  def custom_memory_ratio
36
52
  super
37
53
  end
38
54
 
39
55
  ##
40
56
  # Gets the provisioning level for the requested module.
57
+ # @rspec_example
41
58
  # @return [ProvisionLevel]
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.
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.
45
62
  def level
46
63
  super
47
64
  end
48
65
 
49
66
  ##
50
67
  # Gets all provisionable module
68
+ # @rspec_example
51
69
  # @return [TMOSModule]
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.
70
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
71
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
72
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
55
73
  def list
56
74
  super
57
75
  end
58
76
 
59
77
  ##
60
- # Gets all provisioned module, i.e., all module which have resources to run on the system, i.e., whose provisioning level is not &amp;quot;none".
78
+ # Gets all provisioned module, i.e., all module which have resources to run on the
79
+ # system, i.e., whose provisioning level is not &amp;quot;none".
80
+ # @rspec_example
61
81
  # @return [TMOSModule]
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.
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.
65
85
  def provisioned_list
66
86
  super
67
87
  end
68
88
 
69
89
  ##
70
90
  # Gets the version for this interface.
91
+ # @rspec_example
71
92
  # @return [String]
72
93
  def version
73
94
  super
74
95
  end
75
96
 
76
97
  ##
77
- # Sets the ratios of CPU usage above the minimum levels which are allocated to the requested module. This value is only valid for the &amp;quot;custom" provisioning level.
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.
98
+ # Sets the ratios of CPU usage above the minimum levels which are allocated to the
99
+ # requested module. This value is only valid for the &amp;quot;custom" provisioning
100
+ # level.
101
+ # @rspec_example
102
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
81
105
  # @param [Hash] opts
82
106
  # @option opts [long] :ratios CPU ratios (arbitrary units from 0 to 255) for the requested modules, where zero is equivalent to the "minimum" level (default: 0)
83
107
  def set_custom_cpu_ratio(opts)
@@ -86,10 +110,12 @@ module IControl::Management
86
110
  end
87
111
 
88
112
  ##
89
- # Sets the ratios of disk space above the minimum which are allocated to the requested module. This value is only used for the &amp;quot;custom" provisioning level.
90
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
91
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
92
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
113
+ # Sets the ratios of disk space above the minimum which are allocated to the requested
114
+ # module. This value is only used for the &amp;quot;custom" provisioning level.
115
+ # @rspec_example
116
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
117
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
118
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
93
119
  # @param [Hash] opts
94
120
  # @option opts [long] :ratios Disk space ratios (arbitrary units from 0 to 255) for the requested modules, where zero is equivalent to the "minimum" level (default: 0)
95
121
  def set_custom_disk_ratio(opts)
@@ -98,10 +124,12 @@ module IControl::Management
98
124
  end
99
125
 
100
126
  ##
101
- # Sets the ratios of system memory above the minimum which are allocated to the requested module. This value is only valid for the &amp;quot;custom" provisioning level.
102
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
127
+ # Sets the ratios of system memory above the minimum which are allocated to the requested
128
+ # module. This value is only valid for the &amp;quot;custom" provisioning level.
129
+ # @rspec_example
130
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
131
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
132
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
105
133
  # @param [Hash] opts
106
134
  # @option opts [long] :ratios System memory ratios (arbitrary units from 0 to 255) for the requested modules, where zero is equivalent to the "minimum" level (default: 0)
107
135
  def set_custom_memory_ratio(opts)
@@ -110,10 +138,16 @@ module IControl::Management
110
138
  end
111
139
 
112
140
  ##
113
- # Sets the provisioning level for the requested module. Changing the level for one module may require modifying the level of another module. For example, changing one module to &amp;quot;dedicated" requires setting all others to &amp;quot;none", or setting one module to &amp;quot;custom" requires setting all other module to &amp;quot;custom" or &amp;quot;none". Setting the level of a module to &amp;quot;none" means that the module is not run.
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.
141
+ # Sets the provisioning level for the requested module. Changing the level for one
142
+ # module may require modifying the level of another module. For example, changing one
143
+ # module to &amp;quot;dedicated" requires setting all others to &amp;quot;none", or
144
+ # setting one module to &amp;quot;custom" requires setting all other module to &amp;quot;custom"
145
+ # or &amp;quot;none". Setting the level of a module to &amp;quot;none" means that the
146
+ # module is not run.
147
+ # @rspec_example
148
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
117
151
  # @param [Hash] opts
118
152
  # @option opts [IControl::Management::Provision::ProvisionLevel] :levels Provisioning levels for the requested modules
119
153
  def set_level(opts)
@@ -7,9 +7,10 @@ module IControl::Management
7
7
 
8
8
  ##
9
9
  # Adds/associates servers to this RADIUS 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 RADIUS configurations.
15
16
  def add_server(opts)
@@ -19,9 +20,10 @@ module IControl::Management
19
20
 
20
21
  ##
21
22
  # Creates this RADIUS 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,9 +33,10 @@ module IControl::Management
31
33
 
32
34
  ##
33
35
  # Creates the default authentication RADIUS configuration.
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
  # @param [Hash] opts
38
41
  # @option opts [String] :servers The list of servers to be assigned to the configurations.
39
42
  def create_default_authentication_radius_configuration(opts)
@@ -43,84 +46,98 @@ module IControl::Management
43
46
 
44
47
  ##
45
48
  # Deletes all RADIUS configurations.
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.
49
+ # @rspec_example
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.
49
53
  def delete_all_configurations
50
54
  super
51
55
  end
52
56
 
53
57
  ##
54
58
  # Deletes this RADIUS configurations.
55
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
56
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
57
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
59
+ # @rspec_example
60
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
61
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
62
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
58
63
  def delete_configuration
59
64
  super
60
65
  end
61
66
 
62
67
  ##
63
- # Gets the states indicating whether to enable/disable validation of the accounting response vector. This option should only be set necessary for older servers, i.e. Livingston 1.16.
68
+ # Gets the states indicating whether to enable/disable validation of the accounting
69
+ # response vector. This option should only be set necessary for older servers, i.e.
70
+ # Livingston 1.16.
71
+ # @rspec_example
64
72
  # @return [EnabledState]
65
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
66
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
67
- # @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.
68
76
  def accounting_validation_state
69
77
  super
70
78
  end
71
79
 
72
80
  ##
73
- # Gets the the NAS-Identifier RADIUS attribute with client_ids. If the client_id option is not specified, the PAM service type is used instead. This feature may be disabled by using empty strings for client_ids.
81
+ # Gets the the NAS-Identifier RADIUS attribute with client_ids. If the client_id option
82
+ # is not specified, the PAM service type is used instead. This feature may be disabled
83
+ # by using empty strings for client_ids.
84
+ # @rspec_example
74
85
  # @return [String]
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
  def client_id
79
90
  super
80
91
  end
81
92
 
82
93
  ##
83
94
  # Gets the states indicating whether syslog debugging is enabled/disabled.
95
+ # @rspec_example
84
96
  # @return [EnabledState]
85
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
86
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
87
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
97
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
98
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
99
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
88
100
  def debug_state
89
101
  super
90
102
  end
91
103
 
92
104
  ##
93
105
  # Gets a list of all RADIUS configurations.
106
+ # @rspec_example
94
107
  # @return [String]
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.
108
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
109
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
110
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
98
111
  def list
99
112
  super
100
113
  end
101
114
 
102
115
  ##
103
- # Gets the number of attempts to communicate with the server before concluding that the server has failed.
116
+ # Gets the number of attempts to communicate with the server before concluding that
117
+ # the server has failed.
118
+ # @rspec_example
104
119
  # @return [long]
105
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
106
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
107
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
120
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
121
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
122
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
108
123
  def retry
109
124
  super
110
125
  end
111
126
 
112
127
  ##
113
128
  # Gets the lists of servers this RADIUS configurations are associated with.
129
+ # @rspec_example
114
130
  # @return [String[]]
115
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
131
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
132
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
133
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
118
134
  def server
119
135
  super
120
136
  end
121
137
 
122
138
  ##
123
139
  # Gets the version information for this interface.
140
+ # @rspec_example
124
141
  # @return [String]
125
142
  def version
126
143
  super
@@ -128,18 +145,20 @@ module IControl::Management
128
145
 
129
146
  ##
130
147
  # Removes all servers from this RADIUS configurations.
131
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
132
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
133
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
148
+ # @rspec_example
149
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
150
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
151
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
134
152
  def remove_all_servers
135
153
  super
136
154
  end
137
155
 
138
156
  ##
139
157
  # Removes servers from this RADIUS configurations.
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.
158
+ # @rspec_example
159
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
160
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
161
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
143
162
  # @param [Hash] opts
144
163
  # @option opts [String[]] :servers The servers to remove from the RADIUS configurations.
145
164
  def remove_server(opts)
@@ -148,10 +167,13 @@ module IControl::Management
148
167
  end
149
168
 
150
169
  ##
151
- # Sets the states indicating whether to enable/disable validation of the accounting response vector. This option should only be set necessary for older servers, i.e. Livingston 1.16.
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.
170
+ # Sets the states indicating whether to enable/disable validation of the accounting
171
+ # response vector. This option should only be set necessary for older servers, i.e.
172
+ # Livingston 1.16.
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.
155
177
  # @param [Hash] opts
156
178
  # @option opts [IControl::Common::EnabledState] :states The encryption states of the specified configurations.
157
179
  def set_accounting_validation_state(opts)
@@ -160,10 +182,13 @@ module IControl::Management
160
182
  end
161
183
 
162
184
  ##
163
- # Sets the NAS-Identifier RADIUS attribute with client_ids. If the client_id option is not specified, the PAM service type is used instead. This feature may be disabled by using empty strings for client_ids.
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.
185
+ # Sets the NAS-Identifier RADIUS attribute with client_ids. If the client_id option
186
+ # is not specified, the PAM service type is used instead. This feature may be disabled
187
+ # by using empty strings for client_ids.
188
+ # @rspec_example
189
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
190
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
191
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
167
192
  # @param [Hash] opts
168
193
  # @option opts [String] :client_ids The client ids used by the configurations.
169
194
  def set_client_id(opts)
@@ -173,9 +198,10 @@ module IControl::Management
173
198
 
174
199
  ##
175
200
  # Sets the states indicating whether syslog debugging is enabled/disabled.
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.
201
+ # @rspec_example
202
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
203
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
204
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
179
205
  # @param [Hash] opts
180
206
  # @option opts [IControl::Common::EnabledState] :states The syslog debugging states of the specified configurations.
181
207
  def set_debug_state(opts)
@@ -184,10 +210,12 @@ module IControl::Management
184
210
  end
185
211
 
186
212
  ##
187
- # Sets the number of attempts to communicate with the server before concluding that the server has failed.
188
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
189
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
190
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
213
+ # Sets the number of attempts to communicate with the server before concluding that
214
+ # the server has failed.
215
+ # @rspec_example
216
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
217
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
218
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
191
219
  # @param [Hash] opts
192
220
  # @option opts [long] :retries The retry values used by the configurations.
193
221
  def set_retry(opts)