System¶
Interfaces¶
| Interface | Description |
| CertificateRevocationListFile | Certificate revocation list (CRL) configuration file. These files are intimately tied into the configuration, such that any change to the file itself is treated as a change to the configuration. Such files are also integrated into a file cache for more complete control. |
| Cluster | The Cluster interface enables you to work with the definitions and attributes in a clustered device. |
| ConfigSync | The ConfigSync interface enables you to work with configuration files. For example, use the ConfigSync interface to retrieve a configuration file list, roll up and save a specified configuration, install a configuration on a device, synchronize configuration setups, roll back a configuration, and upload or download a configuration. This interface does not support transactions. |
| Connections | The Connections interface enables you to get information about a device&aposs connections. For example, use Connection interface to get a list of all active connections or to get a list of all active connections for a specific client. |
| CryptoClient | The CryptoClient interface enables a user to manage remote crypto clients. A crypto client is used to establish a session with a remote server that provides cryptographic services. Generally, this is beneficial when the server is using hardware acceleration to perform said services faster than if it was done locally. |
| CryptoServer | The CryptoServer interface enables a user to manage remote crypto servers. A crypto server provides an interface through which cryptographic services can be delivered to remote clients. Generally this is beneficial when the server uses hardware acceleration to perform the services faster than if it was done locally on the client. |
| Disk | The Disk interface enables you to manage the disks in the system. The disk objects come in two flavors. “Physical disks” are the actual hardware disk drives, which can be anything from a true hard disk to a compact flash drive to a USB flash drive. Physical disks are addressed by their serial numbers. “Logical disks” are the view of the disk drives from the system&aposs point of view, abstracting the disk itself, making all disk drives look the same whether they are a true hard disk, a flash drive, or a full disk array. In other words, a logical disk can hold one or more physical disks. Logical disks are addressed by the LogicalDisk identifier, which includes their logical name (e.g., “HD2”, “CF1”, “MD1”) and their chassis slot identifier. It is important to note the potentially confusing relationship between logical and physical disks and their identifiers. All physical disks can be addressed by a LogicalDisk identifier, though it is not guaranteed that all physical disks have an entry in the logical disk table. The logical disk identifier for a physical disk is dependent on the connection of the disk drive to the system, so can change if the system&aposs disk drive configuration changes. On the other hand, all logical disks hold one or more physical disks, which can have a direct one-to-one mapping for a single disk drive or a one-to-many mapping for a disk array. To avoid problems, physical disks should be ideally addressed only by their serial numbers and logical disks only by their LogicalDisk identifiers. Addressing physical disks by their LogicalDisk identifier is supported as a convenience for any user-generated input. Be careful with these distinctions as you use this interface. The application volume component provides better granularity for managing disks. A logical disk can be logically segmented into several application volumes. An application volume belongs to only one logical disk and can never be shared. The visibility of the application volume can be confined to a particular software volume set or it can be made global to make it visible across all control planes. Once set, the volume set visibility property cannot be modified. Application volumes are created during the provisioning of disk-using application modules (e.g., “DATASTOR”, “VCMP” etc.). The application volumes may be discarded by the software(e.g. during module provisioning) unless its preservability property is changed to precious. |
| ExternalMonitorFile | External monitor executeable configuration file. These files are intimately tied into the configuration, such that any change to the file itself is treated as a change to the configuration. Such files are also integrated into a file cache for more complete control. |
| Failover | The Failover interface enables you to manipulate a device&aposs fail-over states. For example, you can get the state, active or standby, in which a device is running in a redundant configuration. You can also switch a device&aposs state from active to standby. This interface does not support transactions. |
| GeoIP | The GeoIP interface enables you to maintain the GeoIP location database. The location database maps IP addresses to geographical locations. This interface does not support transactions. |
| HAGroup | The high availability group is used to calculate a score to determine the relative health of the system. If enabled for a redundant pair, the system with the highest score becomes the active system, everything else being equal. The score is calculated by measuring specified attributes for a set of specified objects (the high availability group). Each object contributes to the total score according to its specified weight. In addition, a value can be added to the total score if a system is currently active, a contribution which can prevent continual failovers due to small fluctuations in the scores on both systems in the redundant pair. This interface configures all of the items listed above, plus retrieves the current high availability score and scores for individual objects. |
| HAStatus | The High Availability (HA) status table is a one-stop destination to retrieve the current status of the high availability features on either the current system or its redundant peer system. The table holds an entry for each feature active on the system. It is important to note that this table can only be read. Enabling and controlling these features is possible through other interfaces, as documented in the Feature enumeration values. |
| Inet | The Inet interface exposes the internal API functionality that you can use to manipulate the rc.conf and resolv.conf files. The ntp.conf file includes the functionality that you can use to set and get the following settings: host name, IP address (get only), router, NTP server and DNS server. |
| Internal | The Internal interface is a private interface to support internal F5 capabilities. |
| LightweightTunnelTableFile | The LightweightTunnelTableFile interface enables you to manipulate Lightweight tunnel file objects. The LightweightTunnelTableFile interface provides the ability to load an external file into lightweight tunnel table that can be accessed by LightWeight4Over6Tunnel profile. These files are intimately tied into the configuration, such that any change to the file itself is treated as a change to the configuration. Such files are also integrated into a file cache for more complete control. |
| PerformanceSFlow | *IMPORTANT* This interface is deprecated (immediately). Please use Management::SFlowReceiver in its stead. The Performance sFlow interface implements the sFlow monitoring standard. The monitoring has two major components: Packet Flow Sampling, a random selection of a fraction of the Packet Flows observed at a data source, and Counter Sampling, a periodic sampling or polling of counters associated with a data source. Samples are sent out, as soon as they are taken, with at most a second of intentional delay, to offline sFlow receivers, through UDP datagrams. It is the responsibility of receivers to maintain the collected data, in any proprietary format. sFlow analyzers, which understand the receivers or their storage format, could be used to analyze the collected data, to represent network usage, over a period of time. This interface allows you to configure one or more sFlow receivers, by providing the IPv4 or IPv6 address and port on which they are listening, along with maximum datagram size and datagram revision they support. One or more data sources can be selected to monitor for counter/packet-flow sampling along with sampling rate. Samples would start to flow to the offline receivers at a rate less than or equal to the set sampling rate. |
| Services | The Services interface enables you to manage the various supported services on the device, such as SSHD, HTTPD, NTPD, and SOD. Note: this interface exposes internal workings of the system, hence, the ability for you to interact with a given service over time as the product changes is not guaranteed. This interface does not support transactions. |
| Session | The Session interface allows you to manage iControl sessions. An iControl session is a set of attributes which can persist across iControl requests for a specific user. These values currently include the active folder and the transaction. By default, a user session is identified by the user&aposs name. However, finer grained control over user session can be gained via an explicit session identifier, which can be requested by a user and included in any subsequent requests which are intended to be included in that session. This interface does not support transactions. |
| SoftwareManagement | The SoftwareManagement interface enables you to manage the software installed on the system. This interface does not support transactions. |
| Statistics | The Statistics interface enables you to get information on various system statistics. This interface does not support transactions. |
| SystemInfo | The SystemInfo interface enables you to query identifying attributes of the system. |
| VCMP | The vCMP interface allows you to create and maintain vCMP guests and manage (vCMP) virtual disks. A vCMP guest is one or more virtual machines (VMs) that together form a TMOS cluster. Note that the virtual disks are created automatically by the system (one may delete them, however). |
Structures¶
Structure
Description
Blade temperature information structure The blades hold a number of temperature sensors, keyed by their slot (i.e., blade) and sensor identifiers.
A structure that contains the CPU metric value.
This structure has been deprecated; use CPUUsageExtendedInformation and related structures instead. A struct that contains the CPU usage for each CPU.
A struct that contains extended CPU usage, per CPU, for a host. The extended CPU usage goes beyond the basic material available in CPUUsage. This structure represents the extended CPU usage as a sequence of sequences of statistics. For a host, there is a sequence of statistics per CPU, and the statistics for a CPU are a sequence.
A struct that contains the extended CPU usage information for a sequence of hosts.
This structure has been deprecated; use CPUUsageExtendedInformation and related structures instead. A struct that contains the CPU usage information.
A struct that contains information for slots in a chassis (or the blades in the slot).
This structure has been deprecated. It was for internal f5 use. Connection information for the system. This contains the local and remote addresses used to connect to the system when using a method that returns this structure. Normally a client would know the “local” address on which it connected to the system, but if network translation changes the destination address of the system, this method can inform the client of the translation without the client having to code the mapping. This is designed to address the scenario in which the system is behind a virtual address or similar and the client needs to learn, for example, whether an address matches the cluster address.
A struct that contains the disk usage for each partition.
A struct that contains the disk usage information.
A structure that contains the fan metric value.
GlobalCPUUsageExtendedInformation
A struct that contains the global CPU usage information. This is one set of combined (“rolled up”) statistics for all hosts.
This structure holds the information for an individual piece of hardware in the system.
A structure that describes device lock
This structure has been deprecated; use get_host_statistics and related methods and data instead. (As of 9.4.0, the system supports retrieving the overall memory attributes by host; retrieving the detailed subsystem attributes by host is not supported). A struct that contains the memory usage information.
A structure that contains the power supply metric value.
A structure that contains the platform CPU information and timestamp.
A structure that contains the platform fan information and timestamp.
A structure that contains the platform power supply information and timestamp.
A structure that contains the platform temperatures and timestamp.
A struct that contains the identifying attributes of the installed products.
This structure has been deprecated; use get_host_statistics and related methods and data instead. A struct that contains the memory usage for each subsystem.
A struct that contains the identifying attributes of the operating system.
A struct that represents both a profile name and the type of profile that is being referenced in the name.
A structure that contains the temperature metric value.
This structure holds a name/value pair describing a characteristic of a piece of hardware, especially items specific to the hardware. Examples include version information and CPU speed.
Enumerations¶
| Enumeration | Description |
| CPUMetricType | An enumeration for different types of CPU metrics. |
| ChassisSlotState | ChassisSlotState enumerates states of a slot in a chassis (or a blade in the slot). |
| ConnectionType | ConnectionType enumerates connection types. It is for internal f5 use. |
| FanMetricType | An enumeration for different types of chassis fan metrics. |
| HardwareType | This enumeration represents a general category of hardware present in the system. |
| PSMetricType | An enumeration for different types of chassis power supply metrics. |
| SystemProfileType | A list of LocalLB profile types used by the System module. |
| TemperatureMetricType | An enumeration for different types of chassis temperature metrics. |
Aliases¶
| Alias | Type | Description |
| BladeTemperatureSequence | BladeTemperature [] | A sequence of sequence of blade temperature measurements |
| CPUMetricSequence | CPUMetric [] | A sequence of CPU metrics for a CPU. |
| CPUUsageExtendedSequence | CPUUsageExtended [] | A sequence of CPUUsageExtended items. |
| CPUUsageSequence | CPUUsage [] | This structure has been deprecated; use CPUUsageExtendedInformation and related structures instead. A sequence of CPUUsage&aposs. |
| ChassisSlotSequence | ChassisSlot [] | A sequence of ChassisSlot items. |
| DiskUsageSequence | DiskUsage [] | A sequence of DiskUsage&aposs. |
| FanMetricSequence | FanMetric [] | A sequence of fan metrics for a fan. |
| HardwareInformationSequence | HardwareInformation [] | A sequence of hardware information structures |
| HardwareTypeSequence | HardwareType [] | A sequence of hardware types |
| LockStatusSequence | LockStatus [] | A sequence of lock status |
| PSMetricSequence | PSMetric [] | A sequence of fan metrics for a chassis power supply. |
| PlatformCPUSequence | CPUMetric [] [] | A sequence of sequence of CPU metrics, as in for multiple CPUs. |
| PlatformFanSequence | FanMetric [] [] | A sequence of sequence of fan metrics, as in for multiple fans. |
| PlatformPSSequence | PSMetric [] [] | A sequence of sequence of power supply metrics, as in for redundant power supplies. |
| PlatformTemperatureSequence | TemperatureMetric [] [] | A sequence of sequence of temperature metrics. |
| SubsystemMemoryUsageSequence | SubsystemMemoryUsage [] | This structure has been deprecated; use get_host_statistics and related methods and data instead. A sequence of SubsystemMemoryUsage&aposs. |
| SystemProfileAttributeSequence | SystemProfileAttribute [] | A sequence of SystemProfileAttributes. |
| SystemProfileAttributeSequenceSequence | SystemProfileAttribute [] [] | A sequence of SystemProfileAttributeSequences. |
| SystemProfileTypeSequence | SystemProfileType [] | A sequence of SystemProfileTypes. |
| TemperatureMetricSequence | TemperatureMetric [] | A sequence of temperature metrics. |
| VersionInformationSequence | VersionInformation [] | A sequence of version information name/value pairs |
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.