System::SystemInfo

Introduced : BIG-IP_v9.0
The SystemInfo interface enables you to query identifying attributes of the system.

Methods

Method Description Introduced
acquire_lock Attempts to acquire lock with specified name for specified number of seconds. These locks can be used to synchronize work of multiple clients working with this device. This call returns immediately. BIG-IP_v9.4.0
get_all_cpu_usage_extended_information Gets the CPU usage extended information for this system by host ID for all hosts. BIG-IP_v9.4.0
get_base_mac_address Gets the system&aposs base MAC address BIG-IP_v10.1.0
get_blade_temperature Gets the temperatures recorded by the blade sensors BIG-IP_v10.1.0
get_chassis_slot_information Gets information regarding the slots in a chassis and the blades in the slots (see ChassisSlot for more information). Note: This method returns useful information only on a chassis; if you call it on a system that is not a chassis, the returned sequence will be empty. BIG-IP_v11.1.0
get_connection_information Note: this method has been deprecated as changes in the system have rendered it problematic. It was intended for internal f5 use and should not be used by customers. Gets connection information (see ConnectionInformation for more info). As of 11.1.0, a connection type of CONNECTION_TYPE_SELF causes the method to return a local address of localhost. BIG-IP_v10.0.1
get_connection_type Note: this method is intended for internal f5 use and should not be used by customers. Gets the connection type. BIG-IP_v11.2.0
get_cpu_metrics Gets the CPU metrics for the CPU(s) on the platform. BIG-IP_v9.0
get_cpu_usage_extended_information Gets the CPU usage extended information for this system by host ID. BIG-IP_v9.4.0
get_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. BIG-IP_v9.2.0
get_disk_usage_information Gets the disk usage information for this system. BIG-IP_v9.2.0
get_fan_metrics Gets the Fan metrics for the Fan(s) on the platform. BIG-IP_v9.0
get_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. BIG-IP_v10.0.0
get_globally_unique_identifier Gets a globally unique identifier for the system. BIG-IP_v9.6.0
get_group_id Gets the unique identifier for the configsync or sync group of which this device is a member. BIG-IP_v9.0
get_hardware_information Gets the information for the hardware in the system. This includes information about CPUs, compression and encryption acceleration hardware, etc. BIG-IP_v10.1.0
get_lock_list Lists all names of currently acquired locks. BIG-IP_v9.4.0
get_lock_status Gets lock statuses of specified locks BIG-IP_v9.4.0
get_marketing_name Gets the F5 marketing name for this platform BIG-IP_v10.1.0
get_memory_usage_information This method has been deprecated; use get_host_statistics and related methods instead. Gets the memory information for this system. BIG-IP_v9.0
get_power_supply_metrics Gets the Power Supply metrics for the Power Supplies on the platform. BIG-IP_v9.0
get_product_information Gets a list of attributes of installed product. BIG-IP_v9.0
get_pva_version Gets the PVA version BIG-IP_v10.1.0
get_system_id Gets the unique identifier for the system. BIG-IP_v9.0
get_system_information Gets the system-identifying attributes of the operating system. BIG-IP_v9.0
get_temperature_metrics Gets the current chassis temperatures. BIG-IP_v9.0
get_time Gets the system time in UTC. BIG-IP_v9.0
get_time_zone Gets the local time zone information. BIG-IP_v9.0
get_uptime Gets the number of seconds the device has been running. BIG-IP_v9.4.0
get_version Gets the version information for this interface. BIG-IP_v9.0
release_lock Attempts to release lock with specified name. These locks can be used to synchronize work of multiple clients working with this device. This call returns immediately. Nothing will happen if specified lock doesn&apost exist. BIG-IP_v9.4.0
set_group_id Sets the unique identifier for the configsync or sync group of which this device is a member. BIG-IP_v9.0
set_time Sets the system time in UTC. BIG-IP_v11.4.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.