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,6 +1,8 @@
1
1
  module IControl::Management
2
2
  ##
3
- # The SNMPConfiguration interface allows users to manage the full configurations for UCD SNMP agent. Please read the manual pages for snmpd.conf for further information. TODO: Missing directives: - override
3
+ # The SNMPConfiguration interface allows users to manage the full configurations for
4
+ # UCD SNMP agent. Please read the manual pages for snmpd.conf for further information.
5
+ # TODO: Missing directives: - override
4
6
  class SNMPConfiguration < IControl::Base
5
7
 
6
8
  set_id_name "sink_info"
@@ -30,6 +32,29 @@ module IControl::Management
30
32
  class ViewInformation < IControl::Base::Struct; end
31
33
  class WrapperSecurityInformation < IControl::Base::Struct; end
32
34
  class WrapperUserInformation < IControl::Base::Struct; end
35
+ class AccessInformationSequence < IControl::Base::Sequence ; end
36
+ class AgentListenAddressPortSequence < IControl::Base::Sequence ; end
37
+ class AgentXInformationSequence < IControl::Base::Sequence ; end
38
+ class ClientAccessSequence < IControl::Base::Sequence ; end
39
+ class DiskCheckInformationSequence < IControl::Base::Sequence ; end
40
+ class DynamicLoadableModuleSequence < IControl::Base::Sequence ; end
41
+ class FileCheckInformationSequence < IControl::Base::Sequence ; end
42
+ class GenericSinkInformation2Sequence < IControl::Base::Sequence ; end
43
+ class GenericSinkInformationSequence < IControl::Base::Sequence ; end
44
+ class GroupInformationSequence < IControl::Base::Sequence ; end
45
+ class LoadAverageInformationSequence < IControl::Base::Sequence ; end
46
+ class MibnumNameProgArgsSequence < IControl::Base::Sequence ; end
47
+ class NameProgArgsSequence < IControl::Base::Sequence ; end
48
+ class PassThroughInformationSequence < IControl::Base::Sequence ; end
49
+ class ProcessInformationSequence < IControl::Base::Sequence ; end
50
+ class ProxyInformationSequence < IControl::Base::Sequence ; end
51
+ class SecurityInformationSequence < IControl::Base::Sequence ; end
52
+ class SinkInformationSequence < IControl::Base::Sequence ; end
53
+ class SmuxSubAgentInformationSequence < IControl::Base::Sequence ; end
54
+ class UserInformationSequence < IControl::Base::Sequence ; end
55
+ class ViewInformationSequence < IControl::Base::Sequence ; end
56
+ class WrapperSecurityInformationSequence < IControl::Base::Sequence ; end
57
+ class WrapperUserInformationSequence < IControl::Base::Sequence ; end
33
58
  # A list of snmp authentication types.
34
59
  class AuthType < IControl::Base::Enumeration; end
35
60
  # The available disk check types.
@@ -42,363 +67,421 @@ module IControl::Management
42
67
  class PrefixType < IControl::Base::Enumeration; end
43
68
  # A list of snmp privacy protocol types.
44
69
  class PrivacyProtocolType < IControl::Base::Enumeration; end
45
- # These types define the hosts to receive traps (and/or inform notifications). The daemon sends a Cold Start trap when it starts up. If enabled, it also sends traps on authentication failures. Multiple trapsink, trap2sink, and informsink lines may be specified to specify mulitple destinations. Use trap2sink to send SNMPv2 traps and informsink to send inform notifications.
70
+ # These types define the hosts to receive traps (and/or inform notifications). The
71
+ # daemon sends a Cold Start trap when it starts up. If enabled, it also sends traps
72
+ # on authentication failures. Multiple trapsink, trap2sink, and informsink lines may
73
+ # be specified to specify mulitple destinations. Use trap2sink to send SNMPv2 traps
74
+ # and informsink to send inform notifications.
46
75
  class SinkType < IControl::Base::Enumeration; end
47
76
  # A list of snmp transport types.
48
77
  class TransportType < IControl::Base::Enumeration; end
49
78
  # A list of snmp view types.
50
79
  class ViewType < IControl::Base::Enumeration; end ##
51
80
  # Gets a list of access maps from group/securitymodel/security level to a view.
81
+ # @rspec_example
52
82
  # @return [AccessInformation]
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.
83
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
84
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
85
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
56
86
  def access_info
57
87
  super
58
88
  end
59
89
 
60
90
  ##
61
91
  # Gets the agent group id.
92
+ # @rspec_example
62
93
  # @return [String]
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.
94
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
95
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
96
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
66
97
  def agent_group_id
67
98
  super
68
99
  end
69
100
 
70
101
  ##
71
102
  # Gets the agent interface information.
103
+ # @rspec_example
72
104
  # @return [AgentInterface]
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.
105
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
106
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
107
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
76
108
  def agent_interface
77
109
  super
78
110
  end
79
111
 
80
112
  ##
81
113
  # Gets a list of agent listen addresses.
114
+ # @rspec_example
82
115
  # @return [AgentListenAddressPort]
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.
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.
86
119
  def agent_listen_address
87
120
  super
88
121
  end
89
122
 
90
123
  ##
91
124
  # Gets the agent trap enabled state
125
+ # @rspec_example
92
126
  # @return [EnabledState]
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.
127
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
128
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
129
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
96
130
  def agent_trap_state
97
131
  super
98
132
  end
99
133
 
100
134
  ##
101
135
  # Gets the agent user id.
136
+ # @rspec_example
102
137
  # @return [String]
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.
138
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
139
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
140
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
106
141
  def agent_user_id
107
142
  super
108
143
  end
109
144
 
110
145
  ##
111
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets the AgentX information.
146
+ # This method is deprecated (immediately) and should not be used, in order to ensure
147
+ # proper operation of the system. Gets the AgentX information.
148
+ # @rspec_example
112
149
  # @return [AgentXInformation]
113
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
150
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
151
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
115
152
  def agentx_information
116
153
  super
117
154
  end
118
155
 
119
156
  ##
120
157
  # Gets the authentication trap enabled state
158
+ # @rspec_example
121
159
  # @return [EnabledState]
122
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
123
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
124
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
125
163
  def auth_trap_state
126
164
  super
127
165
  end
128
166
 
129
167
  ##
130
168
  # Gets a list of disk check instances.
169
+ # @rspec_example
131
170
  # @return [DiskCheckInformation]
132
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
133
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
134
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
135
174
  def check_disk
136
175
  super
137
176
  end
138
177
 
139
178
  ##
140
179
  # Gets a list of available file checks.
180
+ # @rspec_example
141
181
  # @return [FileCheckInformation]
142
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
143
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
144
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
182
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
183
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
184
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
145
185
  def check_file
146
186
  super
147
187
  end
148
188
 
149
189
  ##
150
190
  # Gets load check.
191
+ # @rspec_example
151
192
  # @return [LoadAverageInformation]
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.
193
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
194
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
195
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
155
196
  def check_load
156
197
  super
157
198
  end
158
199
 
159
200
  ##
160
- # Gets a list of process checks. A process check is used to check to see if the process_name'd processes are running on the agent's machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name'd program is not found on the process table as reported by PSCMD.
201
+ # Gets a list of process checks. A process check is used to check to see if the process_name'd
202
+ # processes are running on the agent's machine. An error flag(1) and a description
203
+ # message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG
204
+ # mib columns if the process_name'd program is not found on the process table as reported
205
+ # by PSCMD.
206
+ # @rspec_example
161
207
  # @return [ProcessInformation]
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.
208
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
209
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
210
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
165
211
  def check_process
166
212
  super
167
213
  end
168
214
 
169
215
  ##
170
216
  # Gets a list of client access controls.
217
+ # @rspec_example
171
218
  # @return [ClientAccess]
172
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
173
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
174
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
219
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
175
222
  def client_access
176
223
  super
177
224
  end
178
225
 
179
226
  ##
180
227
  # Gets a list of mappings from a source/community pair to security name.
228
+ # @rspec_example
181
229
  # @return [SecurityInformation]
182
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
183
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
184
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
230
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
231
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
232
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
185
233
  def community_to_security_info
186
234
  super
187
235
  end
188
236
 
189
237
  ##
190
- # Gets a list of SNMPv3 users. Since the authentication and private passphrases have already been munged by snmpd, this information will not be available in the response. Only the user_name, the auth_type, and priv_protocol fields in the UserInformation structure are available.
238
+ # Gets a list of SNMPv3 users. Since the authentication and private passphrases have
239
+ # already been munged by snmpd, this information will not be available in the response.
240
+ # Only the user_name, the auth_type, and priv_protocol fields in the UserInformation
241
+ # structure are available.
242
+ # @rspec_example
191
243
  # @return [UserInformation]
192
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
193
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
194
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
244
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
245
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
246
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
195
247
  def create_user
196
248
  super
197
249
  end
198
250
 
199
251
  ##
200
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets a list of dynamically loadable module instances.
252
+ # This method is deprecated (immediately) and should not be used, in order to ensure
253
+ # proper operation of the system. Gets a list of dynamically loadable module instances.
254
+ # @rspec_example
201
255
  # @return [DynamicLoadableModule]
202
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
203
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
256
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
257
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
204
258
  def dynamic_loadable_module
205
259
  super
206
260
  end
207
261
 
208
262
  ##
209
263
  # Gets the snmp engine identifier.
264
+ # @rspec_example
210
265
  # @return [String]
211
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
212
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
213
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
266
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
267
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
268
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
214
269
  def engine_id
215
270
  super
216
271
  end
217
272
 
218
273
  ##
219
274
  # Gets a list of program instances.
275
+ # @rspec_example
220
276
  # @return [MibnumNameProgArgs]
221
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
222
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
223
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
277
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
278
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
279
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
224
280
  def exec
225
281
  super
226
282
  end
227
283
 
228
284
  ##
229
285
  # Gets a list of exec fix instances.
286
+ # @rspec_example
230
287
  # @return [NameProgArgs]
231
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
232
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
233
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
288
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
289
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
290
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
234
291
  def exec_fix
235
292
  super
236
293
  end
237
294
 
238
295
  ##
239
- # This method is now deprecated. Use method get_generic_traps_v2 instead. Gets a list of generic traps.
296
+ # This method is now deprecated. Use method get_generic_traps_v2 instead. Gets a list
297
+ # of generic traps.
298
+ # @rspec_example
240
299
  # @return [GenericSinkInformation]
241
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
242
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
243
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
300
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
301
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
302
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
244
303
  def generic_traps
245
304
  super
246
305
  end
247
306
 
248
307
  ##
249
308
  # Gets a list of generic traps.
309
+ # @rspec_example
250
310
  # @return [GenericSinkInformation2]
251
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
252
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
253
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
311
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
312
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
313
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
254
314
  def generic_traps_v2
255
315
  super
256
316
  end
257
317
 
258
318
  ##
259
319
  # Gets a list of mappings from securitymodel/securityname to group.
320
+ # @rspec_example
260
321
  # @return [GroupInformation]
261
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
262
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
263
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
322
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
323
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
324
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
264
325
  def group_info
265
326
  super
266
327
  end
267
328
 
268
329
  ##
269
330
  # Return a list of disk devices currently ignored.
331
+ # @rspec_example
270
332
  # @return [String]
271
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
272
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
273
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
333
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
334
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
335
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
274
336
  def ignore_disk
275
337
  super
276
338
  end
277
339
 
278
340
  ##
279
341
  # Gets a list of pass through controls.
342
+ # @rspec_example
280
343
  # @return [PassThroughInformation]
281
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
282
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
283
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
344
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
345
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
346
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
284
347
  def pass_through
285
348
  super
286
349
  end
287
350
 
288
351
  ##
289
352
  # Gets a list of persist pass through controls.
353
+ # @rspec_example
290
354
  # @return [PassThroughInformation]
291
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
292
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
293
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
355
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
356
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
357
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
294
358
  def pass_through_persist
295
359
  super
296
360
  end
297
361
 
298
362
  ##
299
363
  # Retrieves a list of the current process fix instances.
364
+ # @rspec_example
300
365
  # @return [NameProgArgs]
301
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
302
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
303
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
366
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
367
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
368
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
304
369
  def process_fix
305
370
  super
306
371
  end
307
372
 
308
373
  ##
309
374
  # Gets a list of snmp proxies.
375
+ # @rspec_example
310
376
  # @return [String]
311
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
312
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
313
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
377
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
378
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
379
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
314
380
  def proxy
315
381
  super
316
382
  end
317
383
 
318
384
  ##
319
385
  # Gets a list of read-only communities.
386
+ # @rspec_example
320
387
  # @return [WrapperSecurityInformation]
321
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
322
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
323
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
388
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
389
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
390
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
324
391
  def readonly_community
325
392
  super
326
393
  end
327
394
 
328
395
  ##
329
396
  # Gets a list of the SNMPv3 USM read-only users in the VACM access configuration tables.
397
+ # @rspec_example
330
398
  # @return [WrapperUserInformation]
331
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
332
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
333
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
399
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
400
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
401
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
334
402
  def readonly_user
335
403
  super
336
404
  end
337
405
 
338
406
  ##
339
407
  # Gets a list of read-write communities.
408
+ # @rspec_example
340
409
  # @return [WrapperSecurityInformation]
341
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
342
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
343
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
410
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
411
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
412
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
344
413
  def readwrite_community
345
414
  super
346
415
  end
347
416
 
348
417
  ##
349
418
  # Gets a list of the SNMPv3 USM read-write users in the VACM access configuration tables.
419
+ # @rspec_example
350
420
  # @return [WrapperUserInformation]
351
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
352
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
353
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
421
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
422
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
423
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
354
424
  def readwrite_user
355
425
  super
356
426
  end
357
427
 
358
428
  ##
359
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets a list of SMUX based sub-agents.
429
+ # This method is deprecated (immediately) and should not be used, in order to ensure
430
+ # proper operation of the system. Gets a list of SMUX based sub-agents.
431
+ # @rspec_example
360
432
  # @return [SmuxSubAgentInformation]
361
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
362
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
433
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
434
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
363
435
  def smux_subagent
364
436
  super
365
437
  end
366
438
 
367
439
  ##
368
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets directive to indicate how file systems are marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems to be marked as &amp;apos;Network Disks' in the hrStorageTable. This is according to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like file systems to be marked as &amp;apos;Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.
440
+ # This method is deprecated (immediately) and should not be used, in order to ensure
441
+ # proper operation of the system. Gets directive to indicate how file systems are marked
442
+ # by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems to
443
+ # be marked as &amp;apos;Network Disks' in the hrStorageTable. This is according to
444
+ # RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like file
445
+ # systems to be marked as &amp;apos;Fixed Disks' as it has been in previous versions
446
+ # of the ucd-snmp SNMP agent.
447
+ # @rspec_example
369
448
  # @return [long]
370
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
371
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
449
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
450
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
372
451
  def storage_use_nfs
373
452
  super
374
453
  end
375
454
 
376
455
  ##
377
- # Gets the system location, system contact, and system name for the agent. This information is reported in the &amp;apos;system' group in the mibII tree.
456
+ # Gets the system location, system contact, and system name for the agent. This information
457
+ # is reported in the &amp;apos;system' group in the mibII tree.
458
+ # @rspec_example
378
459
  # @return [SystemInformation]
379
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
380
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
381
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
460
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
461
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
462
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
382
463
  def system_information
383
464
  super
384
465
  end
385
466
 
386
467
  ##
387
468
  # Gets the trap community string.
469
+ # @rspec_example
388
470
  # @return [String]
389
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
390
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
391
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
471
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
472
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
473
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
392
474
  def trap_community
393
475
  super
394
476
  end
395
477
 
396
478
  ##
397
479
  # Returns a list of trap sinks.
480
+ # @rspec_example
398
481
  # @return [SinkInformation]
399
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
400
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
401
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
482
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
483
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
484
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
402
485
  # @param [Hash] opts
403
486
  # @option opts [IControl::Management::SNMPConfiguration::SinkType] :sink_type The trap sink type.
404
487
  def trap_sinks(opts)
@@ -408,6 +491,7 @@ module IControl::Management
408
491
 
409
492
  ##
410
493
  # Gets the version information for this interface.
494
+ # @rspec_example
411
495
  # @return [String]
412
496
  def version
413
497
  super
@@ -415,19 +499,21 @@ module IControl::Management
415
499
 
416
500
  ##
417
501
  # Gets a list of named views.
502
+ # @rspec_example
418
503
  # @return [ViewInformation]
419
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
420
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
421
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
504
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
505
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
506
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
422
507
  def view_info
423
508
  super
424
509
  end
425
510
 
426
511
  ##
427
512
  # Removes access maps from group/securitymodel/security level to a view.
428
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
429
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
430
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
513
+ # @rspec_example
514
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
515
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
516
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
431
517
  # @param [Hash] opts
432
518
  # @option opts [IControl::Management::SNMPConfiguration::AccessInformation] :access_info A list of access map definitions.
433
519
  def remove_access_info(opts)
@@ -437,9 +523,10 @@ module IControl::Management
437
523
 
438
524
  ##
439
525
  # Removes the agent group id.
440
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
441
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
442
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
526
+ # @rspec_example
527
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
528
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
529
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
443
530
  # @param [Hash] opts
444
531
  # @option opts [String] :group_id The group id.
445
532
  def remove_agent_group_id(opts)
@@ -449,9 +536,10 @@ module IControl::Management
449
536
 
450
537
  ##
451
538
  # Removes the agent interface information.
452
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
453
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
454
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
539
+ # @rspec_example
540
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
541
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
542
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
455
543
  # @param [Hash] opts
456
544
  # @option opts [IControl::Management::SNMPConfiguration::AgentInterface] :agent_intf The agent interface information.
457
545
  def remove_agent_interface(opts)
@@ -460,10 +548,12 @@ module IControl::Management
460
548
  end
461
549
 
462
550
  ##
463
- # Removes a list of agent listen addresses. Note: As of v9.4.2, this method actually sets the agent listen addresses back to the default.
464
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
465
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
466
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
551
+ # Removes a list of agent listen addresses. Note: As of v9.4.2, this method actually
552
+ # sets the agent listen addresses back to the default.
553
+ # @rspec_example
554
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
555
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
556
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
467
557
  # @param [Hash] opts
468
558
  # @option opts [IControl::Management::SNMPConfiguration::AgentListenAddressPort] :agent_listen_addresses The agent listen information.
469
559
  def remove_agent_listen_address(opts)
@@ -472,10 +562,12 @@ module IControl::Management
472
562
  end
473
563
 
474
564
  ##
475
- # Removes the agent trap enabled state. Note: As of v9.4.2, this method actually sets the agent trap enabled state back to the default.
476
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
477
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
478
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
565
+ # Removes the agent trap enabled state. Note: As of v9.4.2, this method actually sets
566
+ # the agent trap enabled state back to the default.
567
+ # @rspec_example
568
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
569
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
570
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
479
571
  # @param [Hash] opts
480
572
  # @option opts [IControl::Common::EnabledState] :state The agent trap enabled state.
481
573
  def remove_agent_trap_state(opts)
@@ -485,9 +577,10 @@ module IControl::Management
485
577
 
486
578
  ##
487
579
  # Removes the ugent ser id.
488
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
489
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
490
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
580
+ # @rspec_example
581
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
582
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
583
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
491
584
  # @param [Hash] opts
492
585
  # @option opts [String] :user_id The agent user id.
493
586
  def remove_agent_user_id(opts)
@@ -496,9 +589,11 @@ module IControl::Management
496
589
  end
497
590
 
498
591
  ##
499
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes the AgentX information.
500
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
501
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
592
+ # This method is deprecated (immediately) and should not be used, in order to ensure
593
+ # proper operation of the system. Removes the AgentX information.
594
+ # @rspec_example
595
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
596
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
502
597
  # @param [Hash] opts
503
598
  # @option opts [IControl::Management::SNMPConfiguration::AgentXInformation] :agentx_info The AgentX information.
504
599
  def remove_agentx_information(opts)
@@ -507,10 +602,12 @@ module IControl::Management
507
602
  end
508
603
 
509
604
  ##
510
- # Removes the authentication trap enabled state. Note: As of v9.4.2, this method actually sets the authentication trap enabled state back to the default.
511
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
512
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
513
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
605
+ # Removes the authentication trap enabled state. Note: As of v9.4.2, this method actually
606
+ # sets the authentication trap enabled state back to the default.
607
+ # @rspec_example
608
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
609
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
610
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
514
611
  # @param [Hash] opts
515
612
  # @option opts [IControl::Common::EnabledState] :state The authentication trap enabled state.
516
613
  def remove_auth_trap_state(opts)
@@ -520,9 +617,10 @@ module IControl::Management
520
617
 
521
618
  ##
522
619
  # Removes a disk check instance.
523
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
524
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
525
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
620
+ # @rspec_example
621
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
622
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
623
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
526
624
  # @param [Hash] opts
527
625
  # @option opts [IControl::Management::SNMPConfiguration::DiskCheckInformation] :disk_info The disk information for the check.
528
626
  def remove_check_disk(opts)
@@ -532,9 +630,10 @@ module IControl::Management
532
630
 
533
631
  ##
534
632
  # Removes a file check.
535
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
536
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
537
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
633
+ # @rspec_example
634
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
635
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
636
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
538
637
  # @param [Hash] opts
539
638
  # @option opts [IControl::Management::SNMPConfiguration::FileCheckInformation] :file_info The file check information.
540
639
  def remove_check_file(opts)
@@ -544,9 +643,10 @@ module IControl::Management
544
643
 
545
644
  ##
546
645
  # Removes a load check.
547
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
548
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
549
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
646
+ # @rspec_example
647
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
648
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
649
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
550
650
  # @param [Hash] opts
551
651
  # @option opts [IControl::Management::SNMPConfiguration::LoadAverageInformation] :load_info The load check information.
552
652
  def remove_check_load(opts)
@@ -555,10 +655,15 @@ module IControl::Management
555
655
  end
556
656
 
557
657
  ##
558
- # Removes a process check. A process check is used to check to see if the process_name's processes are running on the agent's machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name's program is not found on the process table as reported by PSCMD.
559
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
560
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
561
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
658
+ # Removes a process check. A process check is used to check to see if the process_name's
659
+ # processes are running on the agent's machine. An error flag(1) and a description
660
+ # message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG
661
+ # mib columns if the process_name's program is not found on the process table as reported
662
+ # by PSCMD.
663
+ # @rspec_example
664
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
665
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
666
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
562
667
  # @param [Hash] opts
563
668
  # @option opts [IControl::Management::SNMPConfiguration::ProcessInformation] :proc_info The process check to remove.
564
669
  def remove_check_process(opts)
@@ -568,9 +673,10 @@ module IControl::Management
568
673
 
569
674
  ##
570
675
  # Removes a list of client access controls.
571
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
572
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
573
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
676
+ # @rspec_example
677
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
678
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
679
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
574
680
  # @param [Hash] opts
575
681
  # @option opts [IControl::Management::SNMPConfiguration::ClientAccess] :client_access_info The client access information.
576
682
  def remove_client_access(opts)
@@ -580,9 +686,10 @@ module IControl::Management
580
686
 
581
687
  ##
582
688
  # Removes mappings from a source/community pair to security names.
583
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
584
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
585
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
689
+ # @rspec_example
690
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
691
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
692
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
586
693
  # @param [Hash] opts
587
694
  # @option opts [IControl::Management::SNMPConfiguration::SecurityInformation] :security_info The security mapping information.
588
695
  def remove_community_to_security_info(opts)
@@ -592,9 +699,10 @@ module IControl::Management
592
699
 
593
700
  ##
594
701
  # Removes SNMPv3 users.
595
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
596
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
597
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
702
+ # @rspec_example
703
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
704
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
705
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
598
706
  # @param [Hash] opts
599
707
  # @option opts [IControl::Management::SNMPConfiguration::UserInformation] :user_info The user information.
600
708
  def remove_create_user(opts)
@@ -603,9 +711,11 @@ module IControl::Management
603
711
  end
604
712
 
605
713
  ##
606
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes a dynamically loadable module instance.
607
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
608
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
714
+ # This method is deprecated (immediately) and should not be used, in order to ensure
715
+ # proper operation of the system. Removes a dynamically loadable module instance.
716
+ # @rspec_example
717
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
718
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
609
719
  # @param [Hash] opts
610
720
  # @option opts [IControl::Management::SNMPConfiguration::DynamicLoadableModule] :mod_info The module information.
611
721
  def remove_dynamic_loadable_module(opts)
@@ -615,9 +725,10 @@ module IControl::Management
615
725
 
616
726
  ##
617
727
  # Removes the snmp engine identifier.
618
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
619
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
620
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
728
+ # @rspec_example
729
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
730
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
731
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
621
732
  # @param [Hash] opts
622
733
  # @option opts [String] :engine_id The engine identifier.
623
734
  def remove_engine_id(opts)
@@ -627,9 +738,10 @@ module IControl::Management
627
738
 
628
739
  ##
629
740
  # Removes a program instance.
630
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
631
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
632
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
741
+ # @rspec_example
742
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
743
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
744
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
633
745
  # @param [Hash] opts
634
746
  # @option opts [IControl::Management::SNMPConfiguration::MibnumNameProgArgs] :exec_info The program instance information.
635
747
  def remove_exec(opts)
@@ -639,9 +751,10 @@ module IControl::Management
639
751
 
640
752
  ##
641
753
  # Removes an exec fix instance.
642
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
643
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
644
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
754
+ # @rspec_example
755
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
756
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
757
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
645
758
  # @param [Hash] opts
646
759
  # @option opts [IControl::Management::SNMPConfiguration::NameProgArgs] :exec_info The program information for the fix command.
647
760
  def remove_exec_fix(opts)
@@ -650,28 +763,32 @@ module IControl::Management
650
763
  end
651
764
 
652
765
  ##
653
- # This method is now deprecated. Use method remove_generic_traps_v2 instead. Removes a list of generic traps.
654
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
655
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
656
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
766
+ # This method is now deprecated. Use method remove_generic_traps_v2 instead. Removes
767
+ # a list of generic traps.
768
+ # @rspec_example
769
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
770
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
771
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
657
772
  def remove_generic_traps
658
773
  super
659
774
  end
660
775
 
661
776
  ##
662
777
  # Removes a list of generic traps.
663
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
664
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
665
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
778
+ # @rspec_example
779
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
780
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
781
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
666
782
  def remove_generic_traps_v2
667
783
  super
668
784
  end
669
785
 
670
786
  ##
671
787
  # Removes mappings from securitymodel/securityname to group.
672
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
673
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
674
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
788
+ # @rspec_example
789
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
790
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
791
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
675
792
  # @param [Hash] opts
676
793
  # @option opts [IControl::Management::SNMPConfiguration::GroupInformation] :group_info The group mapping information.
677
794
  def remove_group_info(opts)
@@ -681,9 +798,10 @@ module IControl::Management
681
798
 
682
799
  ##
683
800
  # Removes a disk device from the ignore list.
684
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
685
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
686
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
801
+ # @rspec_example
802
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
803
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
804
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
687
805
  # @param [Hash] opts
688
806
  # @option opts [String] :ignore_disk List of disk devices to ignore
689
807
  def remove_ignore_disk(opts)
@@ -693,9 +811,10 @@ module IControl::Management
693
811
 
694
812
  ##
695
813
  # Removes a list of pass through controls.
696
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
697
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
698
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
814
+ # @rspec_example
815
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
816
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
817
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
699
818
  # @param [Hash] opts
700
819
  # @option opts [IControl::Management::SNMPConfiguration::PassThroughInformation] :passthru_info The pass through information.
701
820
  def remove_pass_through(opts)
@@ -705,9 +824,10 @@ module IControl::Management
705
824
 
706
825
  ##
707
826
  # Removes a list of persist pass through controls.
708
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
709
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
710
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
827
+ # @rspec_example
828
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
829
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
830
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
711
831
  # @param [Hash] opts
712
832
  # @option opts [IControl::Management::SNMPConfiguration::PassThroughInformation] :passthru_info The persist pass through information.
713
833
  def remove_pass_through_persist(opts)
@@ -717,9 +837,10 @@ module IControl::Management
717
837
 
718
838
  ##
719
839
  # Removes a process fix instance.
720
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
721
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
722
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
840
+ # @rspec_example
841
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
842
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
843
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
723
844
  # @param [Hash] opts
724
845
  # @option opts [IControl::Management::SNMPConfiguration::NameProgArgs] :fix_info The program information for the process fix.
725
846
  def remove_process_fix(opts)
@@ -729,9 +850,10 @@ module IControl::Management
729
850
 
730
851
  ##
731
852
  # Removes a list of snmp proxies.
732
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
733
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
734
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
853
+ # @rspec_example
854
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
855
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
856
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
735
857
  # @param [Hash] opts
736
858
  # @option opts [String] :proxy_info The proxy information.
737
859
  def remove_proxy(opts)
@@ -741,9 +863,10 @@ module IControl::Management
741
863
 
742
864
  ##
743
865
  # Removes read-only communities.
744
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
745
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
746
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
866
+ # @rspec_example
867
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
868
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
869
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
747
870
  # @param [Hash] opts
748
871
  # @option opts [IControl::Management::SNMPConfiguration::WrapperSecurityInformation] :ro_community_info The read-only community information.
749
872
  def remove_readonly_community(opts)
@@ -753,9 +876,10 @@ module IControl::Management
753
876
 
754
877
  ##
755
878
  # Removes SNMPv3 USM read-only users from the VACM access configuration tables.
756
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
757
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
758
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
879
+ # @rspec_example
880
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
881
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
882
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
759
883
  # @param [Hash] opts
760
884
  # @option opts [IControl::Management::SNMPConfiguration::WrapperUserInformation] :ro_user_info The read-only user information.
761
885
  def remove_readonly_user(opts)
@@ -765,9 +889,10 @@ module IControl::Management
765
889
 
766
890
  ##
767
891
  # Removes read-write communities.
768
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
769
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
770
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
892
+ # @rspec_example
893
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
894
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
895
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
771
896
  # @param [Hash] opts
772
897
  # @option opts [IControl::Management::SNMPConfiguration::WrapperSecurityInformation] :rw_community_info The read-write community information.
773
898
  def remove_readwrite_community(opts)
@@ -777,9 +902,10 @@ module IControl::Management
777
902
 
778
903
  ##
779
904
  # Removes SNMPv3 USM read-write users from the VACM access configuration tables.
780
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
781
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
782
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
905
+ # @rspec_example
906
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
907
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
908
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
783
909
  # @param [Hash] opts
784
910
  # @option opts [IControl::Management::SNMPConfiguration::WrapperUserInformation] :rw_user_info The read-write user information.
785
911
  def remove_readwrite_user(opts)
@@ -788,9 +914,11 @@ module IControl::Management
788
914
  end
789
915
 
790
916
  ##
791
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes a SMUX based sub-agent.
792
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
793
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
917
+ # This method is deprecated (immediately) and should not be used, in order to ensure
918
+ # proper operation of the system. Removes a SMUX based sub-agent.
919
+ # @rspec_example
920
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
921
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
794
922
  # @param [Hash] opts
795
923
  # @option opts [IControl::Management::SNMPConfiguration::SmuxSubAgentInformation] :subagent_info The sub-agent information.
796
924
  def remove_smux_subagent(opts)
@@ -799,9 +927,16 @@ module IControl::Management
799
927
  end
800
928
 
801
929
  ##
802
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes directive to indicate how file systems are marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems to be marked as &amp;apos;Network Disks' in the hrStorageTable. This is according to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like file systems to be marked as &amp;apos;Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.
803
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
804
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
930
+ # This method is deprecated (immediately) and should not be used, in order to ensure
931
+ # proper operation of the system. Removes directive to indicate how file systems are
932
+ # marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems
933
+ # to be marked as &amp;apos;Network Disks' in the hrStorageTable. This is according
934
+ # to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like
935
+ # file systems to be marked as &amp;apos;Fixed Disks' as it has been in previous versions
936
+ # of the ucd-snmp SNMP agent.
937
+ # @rspec_example
938
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
939
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
805
940
  # @param [Hash] opts
806
941
  # @option opts [long] :usage The usage information.
807
942
  def remove_storage_use_nfs(opts)
@@ -810,10 +945,15 @@ module IControl::Management
810
945
  end
811
946
 
812
947
  ##
813
- # Removes the system location, system contact, and system name for the agent. This information is reported in the &amp;apos;system' group in the mibII tree. Note: As of v9.4.2, this method actually sets the system location and contact parameters and the system services parameter back to the default. As has always been the case, this method affects values only for the system information items you provide (non-empty/non-zero).
814
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
815
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
816
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
948
+ # Removes the system location, system contact, and system name for the agent. This
949
+ # information is reported in the &amp;apos;system' group in the mibII tree. Note: As
950
+ # of v9.4.2, this method actually sets the system location and contact parameters and
951
+ # the system services parameter back to the default. As has always been the case, this
952
+ # method affects values only for the system information items you provide (non-empty/non-zero).
953
+ # @rspec_example
954
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
955
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
956
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
817
957
  # @param [Hash] opts
818
958
  # @option opts [IControl::Management::SNMPConfiguration::SystemInformation] :system_info The system information.
819
959
  def remove_system_information(opts)
@@ -822,10 +962,12 @@ module IControl::Management
822
962
  end
823
963
 
824
964
  ##
825
- # Removes the trap community string. Note: As of v9.4.2, this method actually sets the trap community string back to the default.
826
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
827
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
828
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
965
+ # Removes the trap community string. Note: As of v9.4.2, this method actually sets
966
+ # the trap community string back to the default.
967
+ # @rspec_example
968
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
969
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
970
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
829
971
  # @param [Hash] opts
830
972
  # @option opts [String] :community The trap community string.
831
973
  def remove_trap_community(opts)
@@ -835,9 +977,10 @@ module IControl::Management
835
977
 
836
978
  ##
837
979
  # Removes a list of trap sinks.
838
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
839
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
840
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
980
+ # @rspec_example
981
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
982
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
983
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
841
984
  # @param [Hash] opts
842
985
  # @option opts [IControl::Management::SNMPConfiguration::SinkType] :sink_type The trap sink type.
843
986
  def remove_trap_sinks(opts)
@@ -847,9 +990,10 @@ module IControl::Management
847
990
 
848
991
  ##
849
992
  # Removes a list of named views.
850
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
851
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
852
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
993
+ # @rspec_example
994
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
995
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
996
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
853
997
  # @param [Hash] opts
854
998
  # @option opts [IControl::Management::SNMPConfiguration::ViewInformation] :view_info The view information.
855
999
  def remove_view_info(opts)
@@ -859,9 +1003,10 @@ module IControl::Management
859
1003
 
860
1004
  ##
861
1005
  # Creates access maps from group/securitymodel/security level to a view.
862
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
863
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
864
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1006
+ # @rspec_example
1007
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1008
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1009
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
865
1010
  # @param [Hash] opts
866
1011
  # @option opts [IControl::Management::SNMPConfiguration::AccessInformation] :access_info A list of access map definitions.
867
1012
  def set_access_info(opts)
@@ -870,10 +1015,12 @@ module IControl::Management
870
1015
  end
871
1016
 
872
1017
  ##
873
- # Sets the agent group id. Change to this gid after opening port. The group id may refer to a group by name or a number if the group number starts with a #.
874
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
875
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
876
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1018
+ # Sets the agent group id. Change to this gid after opening port. The group id may
1019
+ # refer to a group by name or a number if the group number starts with a #.
1020
+ # @rspec_example
1021
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1022
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1023
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
877
1024
  # @param [Hash] opts
878
1025
  # @option opts [String] :group_id The group id.
879
1026
  def set_agent_group_id(opts)
@@ -882,10 +1029,12 @@ module IControl::Management
882
1029
  end
883
1030
 
884
1031
  ##
885
- # Sets the interface information for the agent. For interfaces where the agent fails to guess correctly on the type and speed, this directive can supply additional information.
886
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
887
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
888
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1032
+ # Sets the interface information for the agent. For interfaces where the agent fails
1033
+ # to guess correctly on the type and speed, this directive can supply additional information.
1034
+ # @rspec_example
1035
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1036
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1037
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
889
1038
  # @param [Hash] opts
890
1039
  # @option opts [IControl::Management::SNMPConfiguration::AgentInterface] :agent_intf The agent interface information.
891
1040
  def set_agent_interface(opts)
@@ -894,10 +1043,12 @@ module IControl::Management
894
1043
  end
895
1044
 
896
1045
  ##
897
- # Sets a list of agent listen addresses. This makes the agent listen on this list of sockets instead of the default port, which is 161.
898
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
899
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
900
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1046
+ # Sets a list of agent listen addresses. This makes the agent listen on this list of
1047
+ # sockets instead of the default port, which is 161.
1048
+ # @rspec_example
1049
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1050
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1051
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
901
1052
  # @param [Hash] opts
902
1053
  # @option opts [IControl::Management::SNMPConfiguration::AgentListenAddressPort] :agent_listen_addresses The agent listen information.
903
1054
  def set_agent_listen_address(opts)
@@ -907,9 +1058,10 @@ module IControl::Management
907
1058
 
908
1059
  ##
909
1060
  # Sets the agent trap enabled state.
910
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
911
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
912
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1061
+ # @rspec_example
1062
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1063
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1064
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
913
1065
  # @param [Hash] opts
914
1066
  # @option opts [IControl::Common::EnabledState] :state The agent trap enabled state.
915
1067
  def set_agent_trap_state(opts)
@@ -918,10 +1070,12 @@ module IControl::Management
918
1070
  end
919
1071
 
920
1072
  ##
921
- # Sets the agent user id. Change to this uid after opening port. The userid may refer to a user by name or a number if the user number starts with &amp;apos;#'.
922
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
923
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
924
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1073
+ # Sets the agent user id. Change to this uid after opening port. The userid may refer
1074
+ # to a user by name or a number if the user number starts with &amp;apos;#'.
1075
+ # @rspec_example
1076
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1077
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1078
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
925
1079
  # @param [Hash] opts
926
1080
  # @option opts [String] :user_id The agent user id.
927
1081
  def set_agent_user_id(opts)
@@ -930,9 +1084,11 @@ module IControl::Management
930
1084
  end
931
1085
 
932
1086
  ##
933
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Sets the AgentX information.
934
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
935
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
1087
+ # This method is deprecated (immediately) and should not be used, in order to ensure
1088
+ # proper operation of the system. Sets the AgentX information.
1089
+ # @rspec_example
1090
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1091
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
936
1092
  # @param [Hash] opts
937
1093
  # @option opts [IControl::Management::SNMPConfiguration::AgentXInformation] :agentx_info The AgentX information.
938
1094
  def set_agentx_information(opts)
@@ -941,10 +1097,12 @@ module IControl::Management
941
1097
  end
942
1098
 
943
1099
  ##
944
- # Sets the authentication trap enabled state. Setting the trap state to Enabled, enables the generation of authentication failure traps. The default value is Disabled.
945
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
946
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
947
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1100
+ # Sets the authentication trap enabled state. Setting the trap state to Enabled, enables
1101
+ # the generation of authentication failure traps. The default value is Disabled.
1102
+ # @rspec_example
1103
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1104
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1105
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
948
1106
  # @param [Hash] opts
949
1107
  # @option opts [IControl::Common::EnabledState] :state The authentication trap enabled state.
950
1108
  def set_auth_trap_state(opts)
@@ -953,10 +1111,14 @@ module IControl::Management
953
1111
  end
954
1112
 
955
1113
  ##
956
- # Creates a disk check instance. This is used to check the named disks mounted on path for available disk space. If the disk space is less than minimum_space (kb or %), the associated entry in the EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORFLAG mib table will be set to (1) and a descriptive error message will be returned to queries of EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORMSG.
957
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
958
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
959
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1114
+ # Creates a disk check instance. This is used to check the named disks mounted on path
1115
+ # for available disk space. If the disk space is less than minimum_space (kb or %),
1116
+ # the associated entry in the EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORFLAG mib table will
1117
+ # be set to (1) and a descriptive error message will be returned to queries of EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORMSG.
1118
+ # @rspec_example
1119
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1120
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1121
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
960
1122
  # @param [Hash] opts
961
1123
  # @option opts [IControl::Management::SNMPConfiguration::DiskCheckInformation] :disk_info The disk information for the check.
962
1124
  def set_check_disk(opts)
@@ -965,10 +1127,12 @@ module IControl::Management
965
1127
  end
966
1128
 
967
1129
  ##
968
- # Adds a file check used to monitor file sizes and make sure they don't grow beyond a certain size (in kilobytes).
969
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
970
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
971
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1130
+ # Adds a file check used to monitor file sizes and make sure they don't grow beyond
1131
+ # a certain size (in kilobytes).
1132
+ # @rspec_example
1133
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1134
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1135
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
972
1136
  # @param [Hash] opts
973
1137
  # @option opts [IControl::Management::SNMPConfiguration::FileCheckInformation] :file_info The file check information.
974
1138
  def set_check_file(opts)
@@ -977,10 +1141,14 @@ module IControl::Management
977
1141
  end
978
1142
 
979
1143
  ##
980
- # Adds a load check used to check the load average of the machine and returns an error flag (1), and a text-string error message to queries of EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORMSG respectively when the 1-minute, 5-minute, or 15-minute averages exceed the associated maximum values.
981
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
982
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
983
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1144
+ # Adds a load check used to check the load average of the machine and returns an error
1145
+ # flag (1), and a text-string error message to queries of EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORFLAG
1146
+ # and EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORMSG respectively when the 1-minute, 5-minute,
1147
+ # or 15-minute averages exceed the associated maximum values.
1148
+ # @rspec_example
1149
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1150
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1151
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
984
1152
  # @param [Hash] opts
985
1153
  # @option opts [IControl::Management::SNMPConfiguration::LoadAverageInformation] :load_info The load check information.
986
1154
  def set_check_load(opts)
@@ -989,10 +1157,15 @@ module IControl::Management
989
1157
  end
990
1158
 
991
1159
  ##
992
- # Creates a process check. A process check is used to check to see if the process_name's processes are running on the agent's machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name'd program is not found on the process table as reported by PSCMD.
993
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
994
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
995
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1160
+ # Creates a process check. A process check is used to check to see if the process_name's
1161
+ # processes are running on the agent's machine. An error flag(1) and a description
1162
+ # message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG
1163
+ # mib columns if the process_name'd program is not found on the process table as reported
1164
+ # by PSCMD.
1165
+ # @rspec_example
1166
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1167
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1168
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
996
1169
  # @param [Hash] opts
997
1170
  # @option opts [IControl::Management::SNMPConfiguration::ProcessInformation] :proc_info The process check to add.
998
1171
  def set_check_process(opts)
@@ -1001,10 +1174,12 @@ module IControl::Management
1001
1174
  end
1002
1175
 
1003
1176
  ##
1004
- # Creates a list of client access controls. These are stored in the /etc/hosts.allow file.
1005
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1006
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1007
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1177
+ # Creates a list of client access controls. These are stored in the /etc/hosts.allow
1178
+ # file.
1179
+ # @rspec_example
1180
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1181
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1182
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1008
1183
  # @param [Hash] opts
1009
1184
  # @option opts [IControl::Management::SNMPConfiguration::ClientAccess] :client_access_info The access control information.
1010
1185
  def set_client_access(opts)
@@ -1013,10 +1188,12 @@ module IControl::Management
1013
1188
  end
1014
1189
 
1015
1190
  ##
1016
- # Creates mappings from a source/community pair to security names. The first source/community combination that matches the incoming packet is selected.
1017
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1018
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1019
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1191
+ # Creates mappings from a source/community pair to security names. The first source/community
1192
+ # combination that matches the incoming packet is selected.
1193
+ # @rspec_example
1194
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1195
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1196
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1020
1197
  # @param [Hash] opts
1021
1198
  # @option opts [IControl::Management::SNMPConfiguration::SecurityInformation] :security_info The security mapping information.
1022
1199
  def set_community_to_security_info(opts)
@@ -1025,10 +1202,15 @@ module IControl::Management
1025
1202
  end
1026
1203
 
1027
1204
  ##
1028
- # Creates SNMPv3 users. Note: as of v9.4.2, doing this method without having done set_readonly_user or set_readwrite_user first results in a valid (readonly) user rather than silently creating an incomplete but unusable user. However, such behavior is not guaranteed; please do one of the above methods before this method so as to define your new user fully.
1029
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1030
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1031
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1205
+ # Creates SNMPv3 users. Note: as of v9.4.2, doing this method without having done set_readonly_user
1206
+ # or set_readwrite_user first results in a valid (readonly) user rather than silently
1207
+ # creating an incomplete but unusable user. However, such behavior is not guaranteed;
1208
+ # please do one of the above methods before this method so as to define your new user
1209
+ # fully.
1210
+ # @rspec_example
1211
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1212
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1213
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1032
1214
  # @param [Hash] opts
1033
1215
  # @option opts [IControl::Management::SNMPConfiguration::UserInformation] :user_info The user information.
1034
1216
  def set_create_user(opts)
@@ -1037,9 +1219,15 @@ module IControl::Management
1037
1219
  end
1038
1220
 
1039
1221
  ##
1040
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Creates a dynmically loadable module instance. If the agent is built with support for the UCD-DLMOD-MIB it is cabable of loading agent MIB modules dynamically at startup through the dlmod directive and during runtime through the use of the UCD-DLMOD-MIB. The directive loads the shared object module file path which uses the module name prefix.
1041
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1042
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
1222
+ # This method is deprecated (immediately) and should not be used, in order to ensure
1223
+ # proper operation of the system. Creates a dynmically loadable module instance. If
1224
+ # the agent is built with support for the UCD-DLMOD-MIB it is cabable of loading agent
1225
+ # MIB modules dynamically at startup through the dlmod directive and during runtime
1226
+ # through the use of the UCD-DLMOD-MIB. The directive loads the shared object module
1227
+ # file path which uses the module name prefix.
1228
+ # @rspec_example
1229
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1230
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
1043
1231
  # @param [Hash] opts
1044
1232
  # @option opts [IControl::Management::SNMPConfiguration::DynamicLoadableModule] :mod_info The module information.
1045
1233
  def set_dynamic_loadable_module(opts)
@@ -1048,10 +1236,12 @@ module IControl::Management
1048
1236
  end
1049
1237
 
1050
1238
  ##
1051
- # Sets the snmp engine identifier. The snmpd agent needs to be configured with an engine id to be able to respond to SNMPv3 messages.
1052
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1053
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1054
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1239
+ # Sets the snmp engine identifier. The snmpd agent needs to be configured with an engine
1240
+ # id to be able to respond to SNMPv3 messages.
1241
+ # @rspec_example
1242
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1243
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1244
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1055
1245
  # @param [Hash] opts
1056
1246
  # @option opts [String] :engine_id The engine identifier.
1057
1247
  def set_engine_id(opts)
@@ -1060,10 +1250,15 @@ module IControl::Management
1060
1250
  end
1061
1251
 
1062
1252
  ##
1063
- # Creates a program instance, used to signal the agent to execute the named program with the given arguments and returns the exit status and the first line of the STDOUT output of the program to queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORMSG mib columns. The mib_num.ERRORMSG mib contains the entire STDOUT output, one mib table entry per line of output.
1064
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1065
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1066
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1253
+ # Creates a program instance, used to signal the agent to execute the named program
1254
+ # with the given arguments and returns the exit status and the first line of the STDOUT
1255
+ # output of the program to queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORFLAG
1256
+ # and EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORMSG mib columns. The mib_num.ERRORMSG
1257
+ # mib contains the entire STDOUT output, one mib table entry per line of output.
1258
+ # @rspec_example
1259
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1260
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1261
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1067
1262
  # @param [Hash] opts
1068
1263
  # @option opts [IControl::Management::SNMPConfiguration::MibnumNameProgArgs] :exec_info The program instance information.
1069
1264
  def set_exec(opts)
@@ -1072,10 +1267,12 @@ module IControl::Management
1072
1267
  end
1073
1268
 
1074
1269
  ##
1075
- # Sets an exec fix instance that registers a command that knows how to fix errors with the given program.
1076
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1077
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1078
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1270
+ # Sets an exec fix instance that registers a command that knows how to fix errors with
1271
+ # the given program.
1272
+ # @rspec_example
1273
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1274
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1275
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1079
1276
  # @param [Hash] opts
1080
1277
  # @option opts [IControl::Management::SNMPConfiguration::NameProgArgs] :exec_info The program information for the fix command.
1081
1278
  def set_exec_fix(opts)
@@ -1084,28 +1281,34 @@ module IControl::Management
1084
1281
  end
1085
1282
 
1086
1283
  ##
1087
- # This method is now deprecated. Use method set_generic_traps_v2 instead. Creates generic traps that allows any type of trap destination to be specified with any version of SNMP.
1088
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1089
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1090
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1284
+ # This method is now deprecated. Use method set_generic_traps_v2 instead. Creates generic
1285
+ # traps that allows any type of trap destination to be specified with any version of
1286
+ # SNMP.
1287
+ # @rspec_example
1288
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1289
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1290
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1091
1291
  def set_generic_traps
1092
1292
  super
1093
1293
  end
1094
1294
 
1095
1295
  ##
1096
- # Creates generic traps that allows any type of trap destination to be specified with any version of SNMP.
1097
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1098
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1099
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1296
+ # Creates generic traps that allows any type of trap destination to be specified with
1297
+ # any version of SNMP.
1298
+ # @rspec_example
1299
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1300
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1301
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1100
1302
  def set_generic_traps_v2
1101
1303
  super
1102
1304
  end
1103
1305
 
1104
1306
  ##
1105
1307
  # Creates mappings from securitymodel/securityname to group.
1106
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1107
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1108
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1308
+ # @rspec_example
1309
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1310
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1311
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1109
1312
  # @param [Hash] opts
1110
1313
  # @option opts [IControl::Management::SNMPConfiguration::GroupInformation] :group_info The group mapping information.
1111
1314
  def set_group_info(opts)
@@ -1114,10 +1317,15 @@ module IControl::Management
1114
1317
  end
1115
1318
 
1116
1319
  ##
1117
- # Adds disk devices to the ignore list. When scanning for available disk devices the agent might block in trying to open all possible disk devices. This might lead to a timeout wheen walking the device tree. Sometimes it will timeout every time you try it. Adding a ignore disk directive will specify device names not to be checked (i.e. opened).
1118
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1119
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1120
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1320
+ # Adds disk devices to the ignore list. When scanning for available disk devices the
1321
+ # agent might block in trying to open all possible disk devices. This might lead to
1322
+ # a timeout wheen walking the device tree. Sometimes it will timeout every time you
1323
+ # try it. Adding a ignore disk directive will specify device names not to be checked
1324
+ # (i.e. opened).
1325
+ # @rspec_example
1326
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1327
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1328
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1121
1329
  # @param [Hash] opts
1122
1330
  # @option opts [String] :ignore_disk List of disk devices to ignore
1123
1331
  def set_ignore_disk(opts)
@@ -1126,10 +1334,12 @@ module IControl::Management
1126
1334
  end
1127
1335
 
1128
1336
  ##
1129
- # Creates a list of pass through controls. This passes entire control of the mib oid to the executing program.
1130
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1131
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1132
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1337
+ # Creates a list of pass through controls. This passes entire control of the mib oid
1338
+ # to the executing program.
1339
+ # @rspec_example
1340
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1341
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1342
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1133
1343
  # @param [Hash] opts
1134
1344
  # @option opts [IControl::Management::SNMPConfiguration::PassThroughInformation] :passthru_info The pass through information.
1135
1345
  def set_pass_through(opts)
@@ -1138,10 +1348,13 @@ module IControl::Management
1138
1348
  end
1139
1349
 
1140
1350
  ##
1141
- # Creates a list of persist pass through controls. This passes entire control of the mib oid to the executing program. This is similar to set_path_through(), but the executing program continues to run after the initial request is answered.
1142
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1143
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1144
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1351
+ # Creates a list of persist pass through controls. This passes entire control of the
1352
+ # mib oid to the executing program. This is similar to set_path_through(), but the
1353
+ # executing program continues to run after the initial request is answered.
1354
+ # @rspec_example
1355
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1356
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1357
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1145
1358
  # @param [Hash] opts
1146
1359
  # @option opts [IControl::Management::SNMPConfiguration::PassThroughInformation] :passthru_info The pass through information.
1147
1360
  def set_pass_through_persist(opts)
@@ -1150,10 +1363,12 @@ module IControl::Management
1150
1363
  end
1151
1364
 
1152
1365
  ##
1153
- # Sets a process fix instance that registers a command that knows how to fix errors with the given process.
1154
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1155
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1156
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1366
+ # Sets a process fix instance that registers a command that knows how to fix errors
1367
+ # with the given process.
1368
+ # @rspec_example
1369
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1370
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1371
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1157
1372
  # @param [Hash] opts
1158
1373
  # @option opts [IControl::Management::SNMPConfiguration::NameProgArgs] :fix_info The program information for the process fix.
1159
1374
  def set_process_fix(opts)
@@ -1162,10 +1377,12 @@ module IControl::Management
1162
1377
  end
1163
1378
 
1164
1379
  ##
1165
- # Creates a list of snmp proxies. This specifies that any incoming request under oid should be proxied on to a remote host instead.
1166
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1167
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1168
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1380
+ # Creates a list of snmp proxies. This specifies that any incoming request under oid
1381
+ # should be proxied on to a remote host instead.
1382
+ # @rspec_example
1383
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1384
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1385
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1169
1386
  # @param [Hash] opts
1170
1387
  # @option opts [String] :proxy_info The proxy information.
1171
1388
  def set_proxy(opts)
@@ -1174,10 +1391,12 @@ module IControl::Management
1174
1391
  end
1175
1392
 
1176
1393
  ##
1177
- # Creates read-only communities that can be used to access the agent. snmpd supports the View-Based Access Control Model (vacm) as defined in RFC 2275.
1178
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1179
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1180
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1394
+ # Creates read-only communities that can be used to access the agent. snmpd supports
1395
+ # the View-Based Access Control Model (vacm) as defined in RFC 2275.
1396
+ # @rspec_example
1397
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1398
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1399
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1181
1400
  # @param [Hash] opts
1182
1401
  # @option opts [IControl::Management::SNMPConfiguration::WrapperSecurityInformation] :ro_community_info The read-only community information.
1183
1402
  def set_readonly_community(opts)
@@ -1187,9 +1406,10 @@ module IControl::Management
1187
1406
 
1188
1407
  ##
1189
1408
  # Creates SNMPv3 USM read-only users in the VACM access configuration tables.
1190
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1191
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1192
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1409
+ # @rspec_example
1410
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1411
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1412
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1193
1413
  # @param [Hash] opts
1194
1414
  # @option opts [IControl::Management::SNMPConfiguration::WrapperUserInformation] :ro_user_info The read-only user information.
1195
1415
  def set_readonly_user(opts)
@@ -1198,10 +1418,12 @@ module IControl::Management
1198
1418
  end
1199
1419
 
1200
1420
  ##
1201
- # Creates read-write communities that can be used to access the agent. snmpd supports the View-Based Access Control Model (vacm) as defined in RFC 2275.
1202
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1203
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1204
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1421
+ # Creates read-write communities that can be used to access the agent. snmpd supports
1422
+ # the View-Based Access Control Model (vacm) as defined in RFC 2275.
1423
+ # @rspec_example
1424
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1425
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1426
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1205
1427
  # @param [Hash] opts
1206
1428
  # @option opts [IControl::Management::SNMPConfiguration::WrapperSecurityInformation] :rw_community_info The read-write community information.
1207
1429
  def set_readwrite_community(opts)
@@ -1211,9 +1433,10 @@ module IControl::Management
1211
1433
 
1212
1434
  ##
1213
1435
  # Creates SNMPv3 USM read-write users in the VACM access configuration tables.
1214
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1215
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1216
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1436
+ # @rspec_example
1437
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1438
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1439
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1217
1440
  # @param [Hash] opts
1218
1441
  # @option opts [IControl::Management::SNMPConfiguration::WrapperUserInformation] :rw_user_info The read-write user information.
1219
1442
  def set_readwrite_user(opts)
@@ -1222,9 +1445,11 @@ module IControl::Management
1222
1445
  end
1223
1446
 
1224
1447
  ##
1225
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Creates a SMUX based sub-agent, such as gated.
1226
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1227
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
1448
+ # This method is deprecated (immediately) and should not be used, in order to ensure
1449
+ # proper operation of the system. Creates a SMUX based sub-agent, such as gated.
1450
+ # @rspec_example
1451
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1452
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
1228
1453
  # @param [Hash] opts
1229
1454
  # @option opts [IControl::Management::SNMPConfiguration::SmuxSubAgentInformation] :subagent_info The sub-agent information.
1230
1455
  def set_smux_subagent(opts)
@@ -1233,9 +1458,16 @@ module IControl::Management
1233
1458
  end
1234
1459
 
1235
1460
  ##
1236
- # This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Adds a directive to indicate how file systems are marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems to be marked as &amp;apos;Network Disks' in the hrStorageTable. This is according to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like file systems to be marked as &amp;apos;Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.
1237
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1238
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
1461
+ # This method is deprecated (immediately) and should not be used, in order to ensure
1462
+ # proper operation of the system. Adds a directive to indicate how file systems are
1463
+ # marked by SNMP. Setting this directive to 1 causes all NFS and NFS-like file systems
1464
+ # to be marked as &amp;apos;Network Disks' in the hrStorageTable. This is according
1465
+ # to RFC 2790. Not setting storageUseNFS or setting it to 2 causes NFS and NFS-like
1466
+ # file systems to be marked as &amp;apos;Fixed Disks' as it has been in previous versions
1467
+ # of the ucd-snmp SNMP agent.
1468
+ # @rspec_example
1469
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1470
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
1239
1471
  # @param [Hash] opts
1240
1472
  # @option opts [long] :usage The usage information.
1241
1473
  def set_storage_use_nfs(opts)
@@ -1244,10 +1476,14 @@ module IControl::Management
1244
1476
  end
1245
1477
 
1246
1478
  ##
1247
- # Sets the system location, system contact, and system name for the agent. This information is reported in the &amp;apos;system' group in the mibII tree. As has always been the case, this method sets values only for the system information items you provide (non-empty/non-zero).
1248
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1249
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1250
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1479
+ # Sets the system location, system contact, and system name for the agent. This information
1480
+ # is reported in the &amp;apos;system' group in the mibII tree. As has always been
1481
+ # the case, this method sets values only for the system information items you provide
1482
+ # (non-empty/non-zero).
1483
+ # @rspec_example
1484
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1485
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1486
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1251
1487
  # @param [Hash] opts
1252
1488
  # @option opts [IControl::Management::SNMPConfiguration::SystemInformation] :system_info The system information.
1253
1489
  def set_system_information(opts)
@@ -1256,10 +1492,12 @@ module IControl::Management
1256
1492
  end
1257
1493
 
1258
1494
  ##
1259
- # Sets the trap community string. This defines the default community string to be used when sending traps.
1260
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1261
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1262
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1495
+ # Sets the trap community string. This defines the default community string to be used
1496
+ # when sending traps.
1497
+ # @rspec_example
1498
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1499
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1500
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1263
1501
  # @param [Hash] opts
1264
1502
  # @option opts [String] :community The community string.
1265
1503
  def set_trap_community(opts)
@@ -1268,10 +1506,13 @@ module IControl::Management
1268
1506
  end
1269
1507
 
1270
1508
  ##
1271
- # Creates a list of trap sinks. This method create definitions for hosts to receive traps (and/or inform notifications). The daemon sends a Cold Start trap when it starts up. If enabled, it also sends traps on authentication failures.
1272
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1273
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1274
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1509
+ # Creates a list of trap sinks. This method create definitions for hosts to receive
1510
+ # traps (and/or inform notifications). The daemon sends a Cold Start trap when it starts
1511
+ # up. If enabled, it also sends traps on authentication failures.
1512
+ # @rspec_example
1513
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1514
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1515
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1275
1516
  # @param [Hash] opts
1276
1517
  # @option opts [IControl::Management::SNMPConfiguration::SinkType] :sink_type The trap sink type.
1277
1518
  def set_trap_sinks(opts)
@@ -1281,9 +1522,10 @@ module IControl::Management
1281
1522
 
1282
1523
  ##
1283
1524
  # Creates named views.
1284
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
1285
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1286
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1525
+ # @rspec_example
1526
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1527
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1528
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
1287
1529
  # @param [Hash] opts
1288
1530
  # @option opts [IControl::Management::SNMPConfiguration::ViewInformation] :view_info The view information.
1289
1531
  def set_view_info(opts)
@@ -1292,7 +1534,8 @@ module IControl::Management
1292
1534
  end
1293
1535
 
1294
1536
  ##
1295
- # A struct that describes the mapping from group/securitymodel/security level to a view.
1537
+ # A struct that describes the mapping from group/securitymodel/security level to a
1538
+ # view.
1296
1539
  # @attr [String] access_name The name of the access map.
1297
1540
  # @attr [String] access_context The context for the mapping. For the v1 or v2c access model, access_context should be empty, which you must specify not as an empty string but using "" (two double quote characters, possibly escaped appropriately with backslashes as necessary), or else get an exception.
1298
1541
  # @attr [IControl::Management::SNMPConfiguration::ModelType] model The model type to use (any, v1, v2c, or usm).
@@ -1313,7 +1556,8 @@ module IControl::Management
1313
1556
  end
1314
1557
 
1315
1558
  ##
1316
- # For interfaces where the agent fails to correctly guess the type and speed, this directive can supply additional information.
1559
+ # For interfaces where the agent fails to correctly guess the type and speed, this
1560
+ # directive can supply additional information.
1317
1561
  # @attr [String] intf_name The name of the interface.
1318
1562
  # @attr [String] intf_type The interface type as given in the IANAifType-MIB.
1319
1563
  # @attr [String] intf_speed the speed of the interface.
@@ -1324,7 +1568,8 @@ module IControl::Management
1324
1568
  end
1325
1569
 
1326
1570
  ##
1327
- # Makes the agent listen on the specified list of sockets instead of the default port, which is port 161.
1571
+ # Makes the agent listen on the specified list of sockets instead of the default port,
1572
+ # which is port 161.
1328
1573
  # @attr [IControl::Management::SNMPConfiguration::TransportType] transport The trasport type to use (udp or tcp).
1329
1574
  # @attr [IControl::Common::IPPortDefinition] ipport The address and port to use.
1330
1575
  class AgentListenAddressPort < IControl::Base::Struct
@@ -1333,7 +1578,8 @@ module IControl::Management
1333
1578
  end
1334
1579
 
1335
1580
  ##
1336
- # This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. A struct that describes AgentX information.
1581
+ # This type is deprecated (immediately) and should not be used, in order to ensure
1582
+ # proper operation of the system. A struct that describes AgentX information.
1337
1583
  # @attr [String] address The address the master agent listens at.
1338
1584
  # @attr [Numeric] timeout The timeout for an AgentX request, default is 1 second.
1339
1585
  # @attr [Numeric] retries The number of retries for an AgentX request, default is 5.
@@ -1353,7 +1599,10 @@ module IControl::Management
1353
1599
  end
1354
1600
 
1355
1601
  ##
1356
- # This struct is used to check the named disks mounted at disk_path for available disk space. If the disk space is less than minimum_space (kb), the associated entry in the EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORFLAG mib table will be set to (1) and a descriptive error message will be returned to queries of EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORMSG.
1602
+ # This struct is used to check the named disks mounted at disk_path for available disk
1603
+ # space. If the disk space is less than minimum_space (kb), the associated entry in
1604
+ # the EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORFLAG mib table will be set to (1) and a descriptive
1605
+ # error message will be returned to queries of EXTENSIBLEDOTMIB.DISKMIBNUM.1.ERRORMSG.
1357
1606
  # @attr [String] disk_path The mounted path for disk checking.
1358
1607
  # @attr [IControl::Management::SNMPConfiguration::DiskCheckType] check_type The type of disk check to perform.
1359
1608
  # @attr [Numeric] minimum_space The minimum space to use as a check criteria.
@@ -1364,7 +1613,11 @@ module IControl::Management
1364
1613
  end
1365
1614
 
1366
1615
  ##
1367
- # This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. If the agent is built with support for the UCD-DLMOD-MIB, it is cabable of loading agent MIB modules dynamically at startup through the dlmod directive and during runtime through the use of the UCD-DLMOD-MIB. The directive loads the shared object module file path which uses the module name prefix.
1616
+ # This type is deprecated (immediately) and should not be used, in order to ensure
1617
+ # proper operation of the system. If the agent is built with support for the UCD-DLMOD-MIB,
1618
+ # it is cabable of loading agent MIB modules dynamically at startup through the dlmod
1619
+ # directive and during runtime through the use of the UCD-DLMOD-MIB. The directive
1620
+ # loads the shared object module file path which uses the module name prefix.
1368
1621
  # @attr [String] module_name The module name prefix to dynamically load.
1369
1622
  # @attr [String] module_path The module path for the module_name prefix.
1370
1623
  class DynamicLoadableModule < IControl::Base::Struct
@@ -1373,7 +1626,8 @@ module IControl::Management
1373
1626
  end
1374
1627
 
1375
1628
  ##
1376
- # Used to monitor file sizes and make sure they don't grow beyond a certain size (in kilobytes).
1629
+ # Used to monitor file sizes and make sure they don't grow beyond a certain size (in
1630
+ # kilobytes).
1377
1631
  # @attr [String] file_name The file name to monitor for maximum size.
1378
1632
  # @attr [Numeric] maximum_size The maximum size of the file.
1379
1633
  class FileCheckInformation < IControl::Base::Struct
@@ -1382,7 +1636,13 @@ module IControl::Management
1382
1636
  end
1383
1637
 
1384
1638
  ##
1385
- # This structure is now deprecated. Use structure GenericSinkInformation2 instead. This is a more generic trap configuration that allows any type of trap destination to be specified with any version of SNMP. See the snmpcmd(1) manual page for further details on the arguments that can be passed with snmpcmd_args. In addition to the arguments listed there, the special argument -Ci specifies that you want inform notifications to be used instead of unacknowledged traps (this requires that you also specify a version number of v2c or v3 as well).
1639
+ # This structure is now deprecated. Use structure GenericSinkInformation2 instead.
1640
+ # This is a more generic trap configuration that allows any type of trap destination
1641
+ # to be specified with any version of SNMP. See the snmpcmd(1) manual page for further
1642
+ # details on the arguments that can be passed with snmpcmd_args. In addition to the
1643
+ # arguments listed there, the special argument -Ci specifies that you want inform notifications
1644
+ # to be used instead of unacknowledged traps (this requires that you also specify a
1645
+ # version number of v2c or v3 as well).
1386
1646
  # @attr [String] snmpcmd_args Commands to communicate with a network entity using SNMP requests.
1387
1647
  # @attr [String] sink_host The host address for which traps are sent.
1388
1648
  # @attr [String] sink_community The community name of the host to receive trap messages.
@@ -1393,7 +1653,12 @@ module IControl::Management
1393
1653
  end
1394
1654
 
1395
1655
  ##
1396
- # This is a more generic trap configuration (trapsess directive) that allows any type of trap destination to be specified with any version of SNMP. See the snmpcmd(1) manual page for further details on the arguments that can be passed with snmpcmd_args. In addition to the arguments listed there, the special argument -Ci specifies that you want inform notifications to be used instead of unacknowledged traps (this requires that you also specify a version number of v2c or v3 as well).
1656
+ # This is a more generic trap configuration (trapsess directive) that allows any type
1657
+ # of trap destination to be specified with any version of SNMP. See the snmpcmd(1)
1658
+ # manual page for further details on the arguments that can be passed with snmpcmd_args.
1659
+ # In addition to the arguments listed there, the special argument -Ci specifies that
1660
+ # you want inform notifications to be used instead of unacknowledged traps (this requires
1661
+ # that you also specify a version number of v2c or v3 as well).
1397
1662
  # @attr [String] snmpcmd_args Commands to communicate with a network entity using SNMP requests.
1398
1663
  # @attr [String] sink_host The host address for which traps are sent.
1399
1664
  # @attr [Numeric] sink_port The SNMP trap port where traps are sent.
@@ -1415,7 +1680,10 @@ module IControl::Management
1415
1680
  end
1416
1681
 
1417
1682
  ##
1418
- # Used to check the load average of the machine and returns an error flag (1), and a text-string error message to queries of EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORMSG respectively when the 1-minute, 5-minute, or 15-minute averages exceed the associated maximum values.
1683
+ # Used to check the load average of the machine and returns an error flag (1), and
1684
+ # a text-string error message to queries of EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORFLAG
1685
+ # and EXTENSIBLEDOTMIB.LOADAVEMIBNUM.1.ERRORMSG respectively when the 1-minute, 5-minute,
1686
+ # or 15-minute averages exceed the associated maximum values.
1419
1687
  # @attr [Numeric] max_1_minute_load The maximum 1-minute load average.
1420
1688
  # @attr [Numeric] max_5_minute_load The maximum 5-minute load average.
1421
1689
  # @attr [Numeric] max_15_minute_load The maximum 15-minute load average.
@@ -1426,7 +1694,11 @@ module IControl::Management
1426
1694
  end
1427
1695
 
1428
1696
  ##
1429
- # Used to signal the agent to execute the named program with the given arguments and returns the exit status and the first line of the STDOUT output of the program to queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORMSG mib columns. The mib_num.ERRORMSG mib contains the entire STDOUT output, one mib table entry per line of output.
1697
+ # Used to signal the agent to execute the named program with the given arguments and
1698
+ # returns the exit status and the first line of the STDOUT output of the program to
1699
+ # queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.mib_num.ERRORMSG
1700
+ # mib columns. The mib_num.ERRORMSG mib contains the entire STDOUT output, one mib
1701
+ # table entry per line of output.
1430
1702
  # @attr [String] mib_num The mib number index to use for program control
1431
1703
  # @attr [IControl::Management::SNMPConfiguration::NameProgArgs] name_prog_args The program definition.
1432
1704
  class MibnumNameProgArgs < IControl::Base::Struct
@@ -1435,7 +1707,10 @@ module IControl::Management
1435
1707
  end
1436
1708
 
1437
1709
  ##
1438
- # Used to signal the agent to execute the named program with the given arguments and returns the exit status and the first line of the STDOUT output of the program to queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.1.ERRORMSG mib columns. All STDOUT output beyond the first line is silently truncated.
1710
+ # Used to signal the agent to execute the named program with the given arguments and
1711
+ # returns the exit status and the first line of the STDOUT output of the program to
1712
+ # queries of the EXTENSIBLEDOTMIB.SHELLMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.SHELLMIBNUM.1.ERRORMSG
1713
+ # mib columns. All STDOUT output beyond the first line is silently truncated.
1439
1714
  # @attr [String] process_name The process name to query on the agent's machine.
1440
1715
  # @attr [String] program_name The named program to execute.
1441
1716
  # @attr [String] program_args The program's command line arguments.
@@ -1446,7 +1721,8 @@ module IControl::Management
1446
1721
  end
1447
1722
 
1448
1723
  ##
1449
- # A struct that describes the passing of entire control of mib_oid to the exec_name program.
1724
+ # A struct that describes the passing of entire control of mib_oid to the exec_name
1725
+ # program.
1450
1726
  # @attr [String] mib_oid The oid to pass to the given exec_name program.
1451
1727
  # @attr [String] exec_name The program name to pass the mib_oid to.
1452
1728
  class PassThroughInformation < IControl::Base::Struct
@@ -1455,7 +1731,10 @@ module IControl::Management
1455
1731
  end
1456
1732
 
1457
1733
  ##
1458
- # Used to check to see if the process_name'd processes are running on the agent's machine. An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name's program is not found on the process table as reported by PSCMD.
1734
+ # Used to check to see if the process_name'd processes are running on the agent's machine.
1735
+ # An error flag(1) and a description message are then passed to the EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORFLAG
1736
+ # and EXTENSIBLEDOTMIB.PROCMIBNUM.1.ERRORMSG mib columns if the process_name's program
1737
+ # is not found on the process table as reported by PSCMD.
1459
1738
  # @attr [String] process_name The process name to query on the agent's machine.
1460
1739
  # @attr [Numeric] max The maximum number of process instances (0 maps to "infinity").
1461
1740
  # @attr [Numeric] min The minimum number of process instances.
@@ -1466,7 +1745,8 @@ module IControl::Management
1466
1745
  end
1467
1746
 
1468
1747
  ##
1469
- # A struct that describes an snmp proxy. It specifies that any incoming requests under local_oid should be proxied on the remote_host instead.
1748
+ # A struct that describes an snmp proxy. It specifies that any incoming requests under
1749
+ # local_oid should be proxied on the remote_host instead.
1470
1750
  # @attr [String] snmpcmd_args Commands to communicate with a network entity using SNMP requests.
1471
1751
  # @attr [String] remote_host The address of the remote host.
1472
1752
  # @attr [String] local_oid The local oid to proxy.
@@ -1503,7 +1783,8 @@ module IControl::Management
1503
1783
  end
1504
1784
 
1505
1785
  ##
1506
- # This type is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. A struct that describes a smux sub agent.
1786
+ # This type is deprecated (immediately) and should not be used, in order to ensure
1787
+ # proper operation of the system. A struct that describes a smux sub agent.
1507
1788
  # @attr [String] oid The object identifier for the sub agent.
1508
1789
  # @attr [String] password The secret for communications with the sub agent.
1509
1790
  class SmuxSubAgentInformation < IControl::Base::Struct
@@ -1689,7 +1970,11 @@ module IControl::Management
1689
1970
  end
1690
1971
 
1691
1972
 
1692
- # These types define the hosts to receive traps (and/or inform notifications). The daemon sends a Cold Start trap when it starts up. If enabled, it also sends traps on authentication failures. Multiple trapsink, trap2sink, and informsink lines may be specified to specify mulitple destinations. Use trap2sink to send SNMPv2 traps and informsink to send inform notifications.
1973
+ # These types define the hosts to receive traps (and/or inform notifications). The
1974
+ # daemon sends a Cold Start trap when it starts up. If enabled, it also sends traps
1975
+ # on authentication failures. Multiple trapsink, trap2sink, and informsink lines may
1976
+ # be specified to specify mulitple destinations. Use trap2sink to send SNMPv2 traps
1977
+ # and informsink to send inform notifications.
1693
1978
  class SinkType < IControl::Base::Enumeration
1694
1979
  # SNMP traps.
1695
1980
  SINK_TRAPSINK = :SINK_TRAPSINK