Class: IControl::System::SystemInfo

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/system/system_info.rb,
lib/icontrol/system.rb

Overview

The SystemInfo interface enables you to query identifying attributes of the system.

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

- (boolean) acquire_lock(opts)

Attempts to acquire loc with specified name for specified number of seconds. These locs can be used to synchronize work of multiple clients working with this device. This call returns immediately.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :duration_sec (long) —

    Time for how long the system should keep the lock. The lock will be automatically released when duration time is over.

  • :comment (String) —

    Additional user oriented information about this lock.

Returns:

  • (boolean)

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.



20
21
22
23
 
# File 'lib/icontrol/system/system_info.rb', line 20

def acquire_lock(opts)
  check_params(opts,[:duration_sec,:comment])
  super
end

- (CPUUsageExtendedInformation) all_cpu_usage_extended_information

Gets the CPU usage extended information for this system by host ID for all hosts.

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.



32
33
34
 
# File 'lib/icontrol/system/system_info.rb', line 32

def all_cpu_usage_extended_information
  super
end

- (String) base_mac_address

Gets the system's base MAC address

Returns:

  • (String)

Raises:

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

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)
  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



43
44
45
 
# File 'lib/icontrol/system/system_info.rb', line 43

def base_mac_address
  super
end

- (BladeTemperature) blade_temperature

Gets the temperatures recorded by the blade sensors

Returns:

Raises:

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

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)
  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



54
55
56
 
# File 'lib/icontrol/system/system_info.rb', line 54

def blade_temperature
  super
end

- (ConnectionInformation) connection_information

Gets connection information (see ConnectionInformation for more info).

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.



65
66
67
 
# File 'lib/icontrol/system/system_info.rb', line 65

def connection_information
  super
end

- (PlatformCPUs) cpu_metrics

Gets the CPU metrics for the CPU(s) on the platform.

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.



76
77
78
 
# File 'lib/icontrol/system/system_info.rb', line 76

def cpu_metrics
  super
end

- (CPUUsageExtendedInformation) cpu_usage_extended_information(opts)

Gets the CPU usage extended information for this system by host ID.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :host_ids (String) —

    A list of host ids for which to get CPU usage extended 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.



89
90
91
92
 
# File 'lib/icontrol/system/system_info.rb', line 89

def cpu_usage_extended_information(opts)
  check_params(opts,[:host_ids])
  super
end

- (CPUUsageInformation) cpu_usage_information

This method has been deprecated; use get_cpu_usage_extended_information and related methods instead. Gets the CPU usage information for this system.

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.



102
103
104
 
# File 'lib/icontrol/system/system_info.rb', line 102

def cpu_usage_information
  super
end

- (DiskUsageInformation) disk_usage_information

Gets the disk usage information for this system.

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.



113
114
115
 
# File 'lib/icontrol/system/system_info.rb', line 113

def disk_usage_information
  super
end

- (PlatformFans) fan_metrics

Gets the Fan metrics for the Fan(s) on the platform.

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.



124
125
126
 
# File 'lib/icontrol/system/system_info.rb', line 124

def fan_metrics
  super
end

- (GlobalCPUUsageExtendedInformation) global_cpu_usage_extended_information

Gets the global CPU usage extended information for this system. This gets one set of combined ("rolled up") statistics for all hosts. It is not to be confused with get_all_cpu_usage_extended_information, which gets all individual cpu usage statistics, one for each host.

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.



138
139
140
 
# File 'lib/icontrol/system/system_info.rb', line 138

def global_cpu_usage_extended_information
  super
end

- (String) globally_unique_identifier

Gets a globally unique identifier for the system.

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.



149
150
151
 
# File 'lib/icontrol/system/system_info.rb', line 149

def globally_unique_identifier
  super
end

- (String) group_id

Gets the unique identifier for the configsync or sync group of which this device is a member.

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.



161
162
163
 
# File 'lib/icontrol/system/system_info.rb', line 161

def group_id
  super
end

- (HardwareInformation) hardware_information

Gets the information for the hardware in the system. This includes information about CPUs, compression and encryption acceleration hardware, etc.

Returns:

Raises:

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

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)
  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



173
174
175
 
# File 'lib/icontrol/system/system_info.rb', line 173

def hardware_information
  super
end

- (String) lock_list

Lists all names of currently acquired locs.

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.



184
185
186
 
# File 'lib/icontrol/system/system_info.rb', line 184

def lock_list
  super
end

- (LockStatus) lock_status(opts)

Gets loc statuses of specified locs

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :lock_names (String) —

    sequence of lock names.

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.



197
198
199
200
 
# File 'lib/icontrol/system/system_info.rb', line 197

def lock_status(opts)
  check_params(opts,[:lock_names])
  super
end

- (String) marketing_name

Gets the F5 marketing name for this platform

Returns:

  • (String)

Raises:

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

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)
  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



209
210
211
 
# File 'lib/icontrol/system/system_info.rb', line 209

def marketing_name
  super
end

- (MemoryUsageInformation) memory_usage_information

This method has been deprecated; use get_host_statistics and related methods instead. Gets the memory information for this system.

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.



221
222
223
 
# File 'lib/icontrol/system/system_info.rb', line 221

def memory_usage_information
  super
end

- (PlatformPowerSupplies) power_supply_metrics

Gets the Power Supply metrics for the Power Supplies on the platform.

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.



232
233
234
 
# File 'lib/icontrol/system/system_info.rb', line 232

def power_supply_metrics
  super
end

- (ProductInformation) product_information

Gets a list of attributes of installed product.

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.



243
244
245
 
# File 'lib/icontrol/system/system_info.rb', line 243

def product_information
  super
end

- (String) pva_version

Gets the PVA version

Returns:

  • (String)

Raises:

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

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)
  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



254
255
256
 
# File 'lib/icontrol/system/system_info.rb', line 254

def pva_version
  super
end

- (Object) release_lock

Attempts to release loc with specified name. These locs can be used to synchronize work of multiple clients working with this device. This call returns immediately. Nothing will happen if specified loc doesn't exist.

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.



340
341
342
 
# File 'lib/icontrol/system/system_info.rb', line 340

def release_lock
  super
end

- (Object) set_group_id(opts)

Sets the unique identifier for the configsync or sync group of which this device is a member.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :group_id (String) —

    The group 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.



353
354
355
356
 
# File 'lib/icontrol/system/system_info.rb', line 353

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

- (String) system_id

Gets the unique identifier for the system.

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.



265
266
267
 
# File 'lib/icontrol/system/system_info.rb', line 265

def system_id
  super
end

- (SystemInformation) system_information

Gets the system-identifying attributes of the operating system.

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.



276
277
278
 
# File 'lib/icontrol/system/system_info.rb', line 276

def system_information
  super
end

- (PlatformTemperatures) temperature_metrics

Gets the current chassis temperatures.

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.



287
288
289
 
# File 'lib/icontrol/system/system_info.rb', line 287

def temperature_metrics
  super
end

- (TimeStamp) time

Gets the system time in UTC.

Returns:

  • (TimeStamp)

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.



298
299
300
 
# File 'lib/icontrol/system/system_info.rb', line 298

def time
  super
end

- (TimeZone) time_zone

Gets the local time zone information.

Returns:

  • (TimeZone)

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.



309
310
311
 
# File 'lib/icontrol/system/system_info.rb', line 309

def time_zone
  super
end

- (long) uptime

Gets the number of seconds the device has been running.

Returns:

  • (long)

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.



320
321
322
 
# File 'lib/icontrol/system/system_info.rb', line 320

def uptime
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


328
329
330
 
# File 'lib/icontrol/system/system_info.rb', line 328

def version
  super
end