Class: IControl::Management::SNMPConfiguration

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/management/snmp_configuration.rb,
lib/icontrol/management.rb

Overview

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

Defined Under Namespace

Classes: AccessInformation, AccessInformationSequence, AgentInterface, AgentListenAddressPort, AgentListenAddressPortSequence, AgentXInformation, AgentXInformationSequence, AuthType, ClientAccess, ClientAccessSequence, DiskCheckInformation, DiskCheckInformationSequence, DiskCheckType, DynamicLoadableModule, DynamicLoadableModuleSequence, FileCheckInformation, FileCheckInformationSequence, GenericSinkInformation, GenericSinkInformation2, GenericSinkInformation2Sequence, GenericSinkInformationSequence, GroupInformation, GroupInformationSequence, LevelType, LoadAverageInformation, LoadAverageInformationSequence, MibnumNameProgArgs, MibnumNameProgArgsSequence, ModelType, NameProgArgs, NameProgArgsSequence, PassThroughInformation, PassThroughInformationSequence, PrefixType, PrivacyProtocolType, ProcessInformation, ProcessInformationSequence, ProxyInformation, ProxyInformationSequence, SecurityInformation, SecurityInformationSequence, SinkInformation, SinkInformationSequence, SinkType, SmuxSubAgentInformation, SmuxSubAgentInformationSequence, SystemInformation, TransportType, UserInformation, UserInformationSequence, ViewInformation, ViewInformationSequence, ViewType, WrapperSecurityInformation, WrapperSecurityInformationSequence, WrapperUserInformation, WrapperUserInformationSequence

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#access_infoAccessInformation

Gets a list of access maps from group/securitymodel/security level to a view.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



86
87
88
# File 'lib/icontrol/management/snmp_configuration.rb', line 86

def access_info
  super
end

#agent_group_idString

Gets the agent group id.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



97
98
99
# File 'lib/icontrol/management/snmp_configuration.rb', line 97

def agent_group_id
  super
end

#agent_interfaceAgentInterface

Gets the agent interface information.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



108
109
110
# File 'lib/icontrol/management/snmp_configuration.rb', line 108

def agent_interface
  super
end

#agent_listen_addressAgentListenAddressPort

Gets a list of agent listen addresses.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



119
120
121
# File 'lib/icontrol/management/snmp_configuration.rb', line 119

def agent_listen_address
  super
end

#agent_trap_stateEnabledState

Gets the agent trap enabled state

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



130
131
132
# File 'lib/icontrol/management/snmp_configuration.rb', line 130

def agent_trap_state
  super
end

#agent_user_idString

Gets the agent user id.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



141
142
143
# File 'lib/icontrol/management/snmp_configuration.rb', line 141

def agent_user_id
  super
end

#agentx_informationAgentXInformation

This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Gets the AgentX information.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



152
153
154
# File 'lib/icontrol/management/snmp_configuration.rb', line 152

def agentx_information
  super
end

#auth_trap_stateEnabledState

Gets the authentication trap enabled state

Returns:

  • (EnabledState)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



163
164
165
# File 'lib/icontrol/management/snmp_configuration.rb', line 163

def auth_trap_state
  super
end

#check_diskDiskCheckInformation

Gets a list of disk check instances.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



174
175
176
# File 'lib/icontrol/management/snmp_configuration.rb', line 174

def check_disk
  super
end

#check_fileFileCheckInformation

Gets a list of available file checks.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



185
186
187
# File 'lib/icontrol/management/snmp_configuration.rb', line 185

def check_file
  super
end

#check_loadLoadAverageInformation

Gets load check.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



196
197
198
# File 'lib/icontrol/management/snmp_configuration.rb', line 196

def check_load
  super
end

#check_processProcessInformation

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.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



211
212
213
# File 'lib/icontrol/management/snmp_configuration.rb', line 211

def check_process
  super
end

#client_accessClientAccess

Gets a list of client access controls.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



222
223
224
# File 'lib/icontrol/management/snmp_configuration.rb', line 222

def client_access
  super
end

#community_to_security_infoSecurityInformation

Gets a list of mappings from a source/community pair to security name.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



233
234
235
# File 'lib/icontrol/management/snmp_configuration.rb', line 233

def community_to_security_info
  super
end

#create_userUserInformation

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.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



247
248
249
# File 'lib/icontrol/management/snmp_configuration.rb', line 247

def create_user
  super
end

#dynamic_loadable_moduleDynamicLoadableModule

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.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



258
259
260
# File 'lib/icontrol/management/snmp_configuration.rb', line 258

def dynamic_loadable_module
  super
end

#engine_idString

Gets the snmp engine identifier.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



269
270
271
# File 'lib/icontrol/management/snmp_configuration.rb', line 269

def engine_id
  super
end

#execMibnumNameProgArgs

Gets a list of program instances.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



280
281
282
# File 'lib/icontrol/management/snmp_configuration.rb', line 280

def exec
  super
end

#exec_fixNameProgArgs

Gets a list of exec fix instances.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



291
292
293
# File 'lib/icontrol/management/snmp_configuration.rb', line 291

def exec_fix
  super
end

#generic_trapsGenericSinkInformation

This method is now deprecated. Use method get_generic_traps_v2 instead. Gets a list of generic traps.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



303
304
305
# File 'lib/icontrol/management/snmp_configuration.rb', line 303

def generic_traps
  super
end

#generic_traps_v2GenericSinkInformation2

Gets a list of generic traps.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



314
315
316
# File 'lib/icontrol/management/snmp_configuration.rb', line 314

def generic_traps_v2
  super
end

#group_infoGroupInformation

Gets a list of mappings from securitymodel/securityname to group.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



325
326
327
# File 'lib/icontrol/management/snmp_configuration.rb', line 325

def group_info
  super
end

#ignore_diskString

Return a list of disk devices currently ignored.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



336
337
338
# File 'lib/icontrol/management/snmp_configuration.rb', line 336

def ignore_disk
  super
end

#pass_throughPassThroughInformation

Gets a list of pass through controls.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



347
348
349
# File 'lib/icontrol/management/snmp_configuration.rb', line 347

def pass_through
  super
end

#pass_through_persistPassThroughInformation

Gets a list of persist pass through controls.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



358
359
360
# File 'lib/icontrol/management/snmp_configuration.rb', line 358

def pass_through_persist
  super
end

#process_fixNameProgArgs

Retrieves a list of the current process fix instances.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



369
370
371
# File 'lib/icontrol/management/snmp_configuration.rb', line 369

def process_fix
  super
end

#proxyString

Gets a list of snmp proxies.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



380
381
382
# File 'lib/icontrol/management/snmp_configuration.rb', line 380

def proxy
  super
end

#readonly_communityWrapperSecurityInformation

Gets a list of read-only communities.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



391
392
393
# File 'lib/icontrol/management/snmp_configuration.rb', line 391

def readonly_community
  super
end

#readonly_userWrapperUserInformation

Gets a list of the SNMPv3 USM read-only users in the VACM access configuration tables.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



402
403
404
# File 'lib/icontrol/management/snmp_configuration.rb', line 402

def readonly_user
  super
end

#readwrite_communityWrapperSecurityInformation

Gets a list of read-write communities.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



413
414
415
# File 'lib/icontrol/management/snmp_configuration.rb', line 413

def readwrite_community
  super
end

#readwrite_userWrapperUserInformation

Gets a list of the SNMPv3 USM read-write users in the VACM access configuration tables.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



424
425
426
# File 'lib/icontrol/management/snmp_configuration.rb', line 424

def readwrite_user
  super
end

#remove_access_info(opts) ⇒ Object

Removes access maps from group/securitymodel/security level to a view.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



519
520
521
522
# File 'lib/icontrol/management/snmp_configuration.rb', line 519

def remove_access_info(opts)
  check_params(opts,[:access_info])
  super
end

#remove_agent_group_id(opts) ⇒ Object

Removes the agent group id.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :group_id (String)

    The group id.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



532
533
534
535
# File 'lib/icontrol/management/snmp_configuration.rb', line 532

def remove_agent_group_id(opts)
  check_params(opts,[:group_id])
  super
end

#remove_agent_interface(opts) ⇒ Object

Removes the agent interface information.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



545
546
547
548
# File 'lib/icontrol/management/snmp_configuration.rb', line 545

def remove_agent_interface(opts)
  check_params(opts,[:agent_intf])
  super
end

#remove_agent_listen_address(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



559
560
561
562
# File 'lib/icontrol/management/snmp_configuration.rb', line 559

def remove_agent_listen_address(opts)
  check_params(opts,[:agent_listen_addresses])
  super
end

#remove_agent_trap_state(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



573
574
575
576
# File 'lib/icontrol/management/snmp_configuration.rb', line 573

def remove_agent_trap_state(opts)
  check_params(opts,[:state])
  super
end

#remove_agent_user_id(opts) ⇒ Object

Removes the ugent ser id.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :user_id (String)

    The agent user id.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



586
587
588
589
# File 'lib/icontrol/management/snmp_configuration.rb', line 586

def remove_agent_user_id(opts)
  check_params(opts,[:user_id])
  super
end

#remove_agentx_information(opts) ⇒ Object

This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Removes the AgentX information.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



599
600
601
602
# File 'lib/icontrol/management/snmp_configuration.rb', line 599

def remove_agentx_information(opts)
  check_params(opts,[:agentx_info])
  super
end

#remove_auth_trap_state(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



613
614
615
616
# File 'lib/icontrol/management/snmp_configuration.rb', line 613

def remove_auth_trap_state(opts)
  check_params(opts,[:state])
  super
end

#remove_check_disk(opts) ⇒ Object

Removes a disk check instance.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



626
627
628
629
# File 'lib/icontrol/management/snmp_configuration.rb', line 626

def remove_check_disk(opts)
  check_params(opts,[:disk_info])
  super
end

#remove_check_file(opts) ⇒ Object

Removes a file check.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



639
640
641
642
# File 'lib/icontrol/management/snmp_configuration.rb', line 639

def remove_check_file(opts)
  check_params(opts,[:file_info])
  super
end

#remove_check_load(opts) ⇒ Object

Removes a load check.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



652
653
654
655
# File 'lib/icontrol/management/snmp_configuration.rb', line 652

def remove_check_load(opts)
  check_params(opts,[:load_info])
  super
end

#remove_check_process(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



669
670
671
672
# File 'lib/icontrol/management/snmp_configuration.rb', line 669

def remove_check_process(opts)
  check_params(opts,[:proc_info])
  super
end

#remove_client_access(opts) ⇒ Object

Removes a list of client access controls.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



682
683
684
685
# File 'lib/icontrol/management/snmp_configuration.rb', line 682

def remove_client_access(opts)
  check_params(opts,[:client_access_info])
  super
end

#remove_community_to_security_info(opts) ⇒ Object

Removes mappings from a source/community pair to security names.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



695
696
697
698
# File 'lib/icontrol/management/snmp_configuration.rb', line 695

def remove_community_to_security_info(opts)
  check_params(opts,[:security_info])
  super
end

#remove_create_user(opts) ⇒ Object

Removes SNMPv3 users.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



708
709
710
711
# File 'lib/icontrol/management/snmp_configuration.rb', line 708

def remove_create_user(opts)
  check_params(opts,[:user_info])
  super
end

#remove_dynamic_loadable_module(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



721
722
723
724
# File 'lib/icontrol/management/snmp_configuration.rb', line 721

def remove_dynamic_loadable_module(opts)
  check_params(opts,[:mod_info])
  super
end

#remove_engine_id(opts) ⇒ Object

Removes the snmp engine identifier.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :engine_id (String)

    The engine identifier.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



734
735
736
737
# File 'lib/icontrol/management/snmp_configuration.rb', line 734

def remove_engine_id(opts)
  check_params(opts,[:engine_id])
  super
end

#remove_exec(opts) ⇒ Object

Removes a program instance.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



747
748
749
750
# File 'lib/icontrol/management/snmp_configuration.rb', line 747

def remove_exec(opts)
  check_params(opts,[:exec_info])
  super
end

#remove_exec_fix(opts) ⇒ Object

Removes an exec fix instance.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



760
761
762
763
# File 'lib/icontrol/management/snmp_configuration.rb', line 760

def remove_exec_fix(opts)
  check_params(opts,[:exec_info])
  super
end

#remove_generic_trapsObject

This method is now deprecated. Use method remove_generic_traps_v2 instead. Removes a list of generic traps.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



772
773
774
# File 'lib/icontrol/management/snmp_configuration.rb', line 772

def remove_generic_traps
  super
end

#remove_generic_traps_v2Object

Removes a list of generic traps.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



782
783
784
# File 'lib/icontrol/management/snmp_configuration.rb', line 782

def remove_generic_traps_v2
  super
end

#remove_group_info(opts) ⇒ Object

Removes mappings from securitymodel/securityname to group.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



794
795
796
797
# File 'lib/icontrol/management/snmp_configuration.rb', line 794

def remove_group_info(opts)
  check_params(opts,[:group_info])
  super
end

#remove_ignore_disk(opts) ⇒ Object

Removes a disk device from the ignore list.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ignore_disk (String)

    List of disk devices to ignore

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



807
808
809
810
# File 'lib/icontrol/management/snmp_configuration.rb', line 807

def remove_ignore_disk(opts)
  check_params(opts,[:ignore_disk])
  super
end

#remove_pass_through(opts) ⇒ Object

Removes a list of pass through controls.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



820
821
822
823
# File 'lib/icontrol/management/snmp_configuration.rb', line 820

def remove_pass_through(opts)
  check_params(opts,[:passthru_info])
  super
end

#remove_pass_through_persist(opts) ⇒ Object

Removes a list of persist pass through controls.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



833
834
835
836
# File 'lib/icontrol/management/snmp_configuration.rb', line 833

def remove_pass_through_persist(opts)
  check_params(opts,[:passthru_info])
  super
end

#remove_process_fix(opts) ⇒ Object

Removes a process fix instance.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



846
847
848
849
# File 'lib/icontrol/management/snmp_configuration.rb', line 846

def remove_process_fix(opts)
  check_params(opts,[:fix_info])
  super
end

#remove_proxy(opts) ⇒ Object

Removes a list of snmp proxies.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :proxy_info (String)

    The proxy information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



859
860
861
862
# File 'lib/icontrol/management/snmp_configuration.rb', line 859

def remove_proxy(opts)
  check_params(opts,[:proxy_info])
  super
end

#remove_readonly_community(opts) ⇒ Object

Removes read-only communities.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



872
873
874
875
# File 'lib/icontrol/management/snmp_configuration.rb', line 872

def remove_readonly_community(opts)
  check_params(opts,[:ro_community_info])
  super
end

#remove_readonly_user(opts) ⇒ Object

Removes SNMPv3 USM read-only users from the VACM access configuration tables.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



885
886
887
888
# File 'lib/icontrol/management/snmp_configuration.rb', line 885

def remove_readonly_user(opts)
  check_params(opts,[:ro_user_info])
  super
end

#remove_readwrite_community(opts) ⇒ Object

Removes read-write communities.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



898
899
900
901
# File 'lib/icontrol/management/snmp_configuration.rb', line 898

def remove_readwrite_community(opts)
  check_params(opts,[:rw_community_info])
  super
end

#remove_readwrite_user(opts) ⇒ Object

Removes SNMPv3 USM read-write users from the VACM access configuration tables.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



911
912
913
914
# File 'lib/icontrol/management/snmp_configuration.rb', line 911

def remove_readwrite_user(opts)
  check_params(opts,[:rw_user_info])
  super
end

#remove_smux_subagent(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



924
925
926
927
# File 'lib/icontrol/management/snmp_configuration.rb', line 924

def remove_smux_subagent(opts)
  check_params(opts,[:subagent_info])
  super
end

#remove_storage_use_nfs(opts) ⇒ Object

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 '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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :usage (long)

    The usage information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



942
943
944
945
# File 'lib/icontrol/management/snmp_configuration.rb', line 942

def remove_storage_use_nfs(opts)
  check_params(opts,[:usage])
  super
end

#remove_system_information(opts) ⇒ Object

Removes the system location, system contact, and system name for the agent. This information is reported in the '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).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



959
960
961
962
# File 'lib/icontrol/management/snmp_configuration.rb', line 959

def remove_system_information(opts)
  check_params(opts,[:system_info])
  super
end

#remove_trap_community(opts) ⇒ Object

Removes the trap community string. Note: As of v9.4.2, this method actually sets the trap community string back to the default.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :community (String)

    The trap community string.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



973
974
975
976
# File 'lib/icontrol/management/snmp_configuration.rb', line 973

def remove_trap_community(opts)
  check_params(opts,[:community])
  super
end

#remove_trap_sinks(opts) ⇒ Object

Removes a list of trap sinks.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



986
987
988
989
# File 'lib/icontrol/management/snmp_configuration.rb', line 986

def remove_trap_sinks(opts)
  check_params(opts,[:sink_type])
  super
end

#remove_view_info(opts) ⇒ Object

Removes a list of named views.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



999
1000
1001
1002
# File 'lib/icontrol/management/snmp_configuration.rb', line 999

def remove_view_info(opts)
  check_params(opts,[:view_info])
  super
end

#set_access_info(opts) ⇒ Object

Creates access maps from group/securitymodel/security level to a view.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1012
1013
1014
1015
# File 'lib/icontrol/management/snmp_configuration.rb', line 1012

def set_access_info(opts)
  check_params(opts,[:access_info])
  super
end

#set_agent_group_id(opts) ⇒ Object

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 #.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :group_id (String)

    The group id.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1026
1027
1028
1029
# File 'lib/icontrol/management/snmp_configuration.rb', line 1026

def set_agent_group_id(opts)
  check_params(opts,[:group_id])
  super
end

#set_agent_interface(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1040
1041
1042
1043
# File 'lib/icontrol/management/snmp_configuration.rb', line 1040

def set_agent_interface(opts)
  check_params(opts,[:agent_intf])
  super
end

#set_agent_listen_address(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1054
1055
1056
1057
# File 'lib/icontrol/management/snmp_configuration.rb', line 1054

def set_agent_listen_address(opts)
  check_params(opts,[:agent_listen_addresses])
  super
end

#set_agent_trap_state(opts) ⇒ Object

Sets the agent trap enabled state.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1067
1068
1069
1070
# File 'lib/icontrol/management/snmp_configuration.rb', line 1067

def set_agent_trap_state(opts)
  check_params(opts,[:state])
  super
end

#set_agent_user_id(opts) ⇒ Object

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 '#'.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :user_id (String)

    The agent user id.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1081
1082
1083
1084
# File 'lib/icontrol/management/snmp_configuration.rb', line 1081

def set_agent_user_id(opts)
  check_params(opts,[:user_id])
  super
end

#set_agentx_information(opts) ⇒ Object

This method is deprecated (immediately) and should not be used, in order to ensure proper operation of the system. Sets the AgentX information.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



1094
1095
1096
1097
# File 'lib/icontrol/management/snmp_configuration.rb', line 1094

def set_agentx_information(opts)
  check_params(opts,[:agentx_info])
  super
end

#set_auth_trap_state(opts) ⇒ Object

Sets the authentication trap enabled state. Setting the trap state to Enabled, enables the generation of authentication failure traps. The default value is Disabled.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1108
1109
1110
1111
# File 'lib/icontrol/management/snmp_configuration.rb', line 1108

def set_auth_trap_state(opts)
  check_params(opts,[:state])
  super
end

#set_check_disk(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1124
1125
1126
1127
# File 'lib/icontrol/management/snmp_configuration.rb', line 1124

def set_check_disk(opts)
  check_params(opts,[:disk_info])
  super
end

#set_check_file(opts) ⇒ Object

Adds a file check used to monitor file sizes and make sure they don't grow beyond a certain size (in kilobytes).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1138
1139
1140
1141
# File 'lib/icontrol/management/snmp_configuration.rb', line 1138

def set_check_file(opts)
  check_params(opts,[:file_info])
  super
end

#set_check_load(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1154
1155
1156
1157
# File 'lib/icontrol/management/snmp_configuration.rb', line 1154

def set_check_load(opts)
  check_params(opts,[:load_info])
  super
end

#set_check_process(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1171
1172
1173
1174
# File 'lib/icontrol/management/snmp_configuration.rb', line 1171

def set_check_process(opts)
  check_params(opts,[:proc_info])
  super
end

#set_client_access(opts) ⇒ Object

Creates a list of client access controls. These are stored in the /etc/hosts.allow file.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1185
1186
1187
1188
# File 'lib/icontrol/management/snmp_configuration.rb', line 1185

def set_client_access(opts)
  check_params(opts,[:client_access_info])
  super
end

#set_community_to_security_info(opts) ⇒ Object

Creates mappings from a source/community pair to security names. The first source/community combination that matches the incoming packet is selected.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1199
1200
1201
1202
# File 'lib/icontrol/management/snmp_configuration.rb', line 1199

def set_community_to_security_info(opts)
  check_params(opts,[:security_info])
  super
end

#set_create_user(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1216
1217
1218
1219
# File 'lib/icontrol/management/snmp_configuration.rb', line 1216

def set_create_user(opts)
  check_params(opts,[:user_info])
  super
end

#set_dynamic_loadable_module(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



1233
1234
1235
1236
# File 'lib/icontrol/management/snmp_configuration.rb', line 1233

def set_dynamic_loadable_module(opts)
  check_params(opts,[:mod_info])
  super
end

#set_engine_id(opts) ⇒ Object

Sets the snmp engine identifier. The snmpd agent needs to be configured with an engine id to be able to respond to SNMPv3 messages.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :engine_id (String)

    The engine identifier.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1247
1248
1249
1250
# File 'lib/icontrol/management/snmp_configuration.rb', line 1247

def set_engine_id(opts)
  check_params(opts,[:engine_id])
  super
end

#set_exec(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1264
1265
1266
1267
# File 'lib/icontrol/management/snmp_configuration.rb', line 1264

def set_exec(opts)
  check_params(opts,[:exec_info])
  super
end

#set_exec_fix(opts) ⇒ Object

Sets an exec fix instance that registers a command that knows how to fix errors with the given program.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1278
1279
1280
1281
# File 'lib/icontrol/management/snmp_configuration.rb', line 1278

def set_exec_fix(opts)
  check_params(opts,[:exec_info])
  super
end

#set_generic_trapsObject

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.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1291
1292
1293
# File 'lib/icontrol/management/snmp_configuration.rb', line 1291

def set_generic_traps
  super
end

#set_generic_traps_v2Object

Creates generic traps that allows any type of trap destination to be specified with any version of SNMP.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1302
1303
1304
# File 'lib/icontrol/management/snmp_configuration.rb', line 1302

def set_generic_traps_v2
  super
end

#set_group_info(opts) ⇒ Object

Creates mappings from securitymodel/securityname to group.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1314
1315
1316
1317
# File 'lib/icontrol/management/snmp_configuration.rb', line 1314

def set_group_info(opts)
  check_params(opts,[:group_info])
  super
end

#set_ignore_disk(opts) ⇒ Object

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).

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ignore_disk (String)

    List of disk devices to ignore

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1331
1332
1333
1334
# File 'lib/icontrol/management/snmp_configuration.rb', line 1331

def set_ignore_disk(opts)
  check_params(opts,[:ignore_disk])
  super
end

#set_pass_through(opts) ⇒ Object

Creates a list of pass through controls. This passes entire control of the mib oid to the executing program.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1345
1346
1347
1348
# File 'lib/icontrol/management/snmp_configuration.rb', line 1345

def set_pass_through(opts)
  check_params(opts,[:passthru_info])
  super
end

#set_pass_through_persist(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1360
1361
1362
1363
# File 'lib/icontrol/management/snmp_configuration.rb', line 1360

def set_pass_through_persist(opts)
  check_params(opts,[:passthru_info])
  super
end

#set_process_fix(opts) ⇒ Object

Sets a process fix instance that registers a command that knows how to fix errors with the given process.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1374
1375
1376
1377
# File 'lib/icontrol/management/snmp_configuration.rb', line 1374

def set_process_fix(opts)
  check_params(opts,[:fix_info])
  super
end

#set_proxy(opts) ⇒ Object

Creates a list of snmp proxies. This specifies that any incoming request under oid should be proxied on to a remote host instead.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :proxy_info (String)

    The proxy information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1388
1389
1390
1391
# File 'lib/icontrol/management/snmp_configuration.rb', line 1388

def set_proxy(opts)
  check_params(opts,[:proxy_info])
  super
end

#set_readonly_community(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1402
1403
1404
1405
# File 'lib/icontrol/management/snmp_configuration.rb', line 1402

def set_readonly_community(opts)
  check_params(opts,[:ro_community_info])
  super
end

#set_readonly_user(opts) ⇒ Object

Creates SNMPv3 USM read-only users in the VACM access configuration tables.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1415
1416
1417
1418
# File 'lib/icontrol/management/snmp_configuration.rb', line 1415

def set_readonly_user(opts)
  check_params(opts,[:ro_user_info])
  super
end

#set_readwrite_community(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1429
1430
1431
1432
# File 'lib/icontrol/management/snmp_configuration.rb', line 1429

def set_readwrite_community(opts)
  check_params(opts,[:rw_community_info])
  super
end

#set_readwrite_user(opts) ⇒ Object

Creates SNMPv3 USM read-write users in the VACM access configuration tables.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1442
1443
1444
1445
# File 'lib/icontrol/management/snmp_configuration.rb', line 1442

def set_readwrite_user(opts)
  check_params(opts,[:rw_user_info])
  super
end

#set_smux_subagent(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



1455
1456
1457
1458
# File 'lib/icontrol/management/snmp_configuration.rb', line 1455

def set_smux_subagent(opts)
  check_params(opts,[:subagent_info])
  super
end

#set_storage_use_nfs(opts) ⇒ Object

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 '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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :usage (long)

    The usage information.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



1473
1474
1475
1476
# File 'lib/icontrol/management/snmp_configuration.rb', line 1473

def set_storage_use_nfs(opts)
  check_params(opts,[:usage])
  super
end

#set_system_information(opts) ⇒ Object

Sets the system location, system contact, and system name for the agent. This information is reported in the '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).

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1489
1490
1491
1492
# File 'lib/icontrol/management/snmp_configuration.rb', line 1489

def set_system_information(opts)
  check_params(opts,[:system_info])
  super
end

#set_trap_community(opts) ⇒ Object

Sets the trap community string. This defines the default community string to be used when sending traps.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :community (String)

    The community string.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1503
1504
1505
1506
# File 'lib/icontrol/management/snmp_configuration.rb', line 1503

def set_trap_community(opts)
  check_params(opts,[:community])
  super
end

#set_trap_sinks(opts) ⇒ Object

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.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1518
1519
1520
1521
# File 'lib/icontrol/management/snmp_configuration.rb', line 1518

def set_trap_sinks(opts)
  check_params(opts,[:sink_type])
  super
end

#set_view_info(opts) ⇒ Object

Creates named views.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



1531
1532
1533
1534
# File 'lib/icontrol/management/snmp_configuration.rb', line 1531

def set_view_info(opts)
  check_params(opts,[:view_info])
  super
end

#smux_subagentSmuxSubAgentInformation

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.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



435
436
437
# File 'lib/icontrol/management/snmp_configuration.rb', line 435

def smux_subagent
  super
end

#storage_use_nfslong

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 '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 'Fixed Disks' as it has been in previous versions of the ucd-snmp SNMP agent.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented)

    raised if the method is not supported or implemented.



451
452
453
# File 'lib/icontrol/management/snmp_configuration.rb', line 451

def storage_use_nfs
  super
end

#system_informationSystemInformation

Gets the system location, system contact, and system name for the agent. This information is reported in the 'system' group in the mibII tree.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



463
464
465
# File 'lib/icontrol/management/snmp_configuration.rb', line 463

def system_information
  super
end

#trap_communityString

Gets the trap community string.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



474
475
476
# File 'lib/icontrol/management/snmp_configuration.rb', line 474

def trap_community
  super
end

#trap_sinks(opts) ⇒ SinkInformation

Returns a list of trap sinks.

Parameters:

  • opts (Hash)

Options Hash (opts):

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



487
488
489
490
# File 'lib/icontrol/management/snmp_configuration.rb', line 487

def trap_sinks(opts)
  check_params(opts,[:sink_type])
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


496
497
498
# File 'lib/icontrol/management/snmp_configuration.rb', line 496

def version
  super
end

#view_infoViewInformation

Gets a list of named views.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



507
508
509
# File 'lib/icontrol/management/snmp_configuration.rb', line 507

def view_info
  super
end