LocalLB::NodeAddressV2¶
Introduced : BIG-IP_v11.0.0
The NodeAddress interface enables you to work with the states,
statistics, limits, availability, ratios, application response deltas,
and monitors of a local load balancer&aposs node address. This updated
interface is required to support the switch from accessing node
addresses via their IP address to their name.
Methods¶
| Method | Description | Introduced |
| add_metadata | Adds the metadata for the specified nodes. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| create | Creates the specified node addresses. | BIG-IP_v11.0.0 |
| delete_all_node_addresses | Deletes all node addresses. | BIG-IP_v11.0.0 |
| delete_node_address | Deletes the specified node addresses. | BIG-IP_v11.0.0 |
| get_address | Gets the IP addresses for a set of node addresses. Note: A set_address method is not supported. | BIG-IP_v11.0.0 |
| get_all_statistics | Gets the statistics for all the node addresses. | BIG-IP_v11.0.0 |
| get_connection_limit | Gets the connection limits for the specified node addresses. Note that the limit data type was ULong64 in previous versions. | BIG-IP_v11.0.0 |
| get_default_node_monitor | Gets the default node monitor rule. | BIG-IP_v11.0.0 |
| get_description | Gets the descriptions for a set of node addresses. | BIG-IP_v11.0.0 |
| get_dynamic_ratio | This method is deprecated because dynamic ratio can be ULong, not just UShort. If longer values than this method has allowed are set, then this method may return incorrect values. Please use get_dynamic_ratio_v2. Gets the dynamic ratios for the specified node addresses. | BIG-IP_v11.0.0 |
| get_dynamic_ratio_v2 | Gets the dynamic ratios for the specified node addresses. | BIG-IP_v11.3.0 |
| get_list | Gets a list of all node addresses. | BIG-IP_v11.0.0 |
| get_metadata | Gets the user metadata for the specified nodes. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. | BIG-IP_v11.2.0 |
| get_metadata_description | Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_persistence | Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_value | Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_monitor_instance | Gets the monitor instance information for the specified node addresses. | BIG-IP_v11.0.0 |
| get_monitor_logging_state | Gets the node monitor logging states. | BIG-IP_v11.5.0 |
| get_monitor_rule | Gets the monitor rules used by the specified node addresses, i.e. the monitor rules used by the node addresses. Note: If the node uses the default node monitor, this method retrieves the default node monitor. | BIG-IP_v11.0.0 |
| get_monitor_status | Gets the current availability status of the specified node addresses. | BIG-IP_v11.0.0 |
| get_object_status | Gets the statuses of the specified node addresses. | BIG-IP_v11.0.0 |
| get_rate_limit | Gets the rate limits for the specified node addresses. | BIG-IP_v11.2.1 |
| get_ratio | Gets the ratios for the specified node addresses. | BIG-IP_v11.0.0 |
| get_session_status | Gets the current session statuses of the specified node addresses. | BIG-IP_v11.0.0 |
| get_statistics | Gets the statistics for the specified node. | BIG-IP_v11.0.0 |
| get_traffic_acceleration_status | Gets the traffic acceleration status of the specified node addresses, which specifies whether the node address is in use by traffic acceleration. | BIG-IP_v13.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.0.0 |
| remove_all_metadata | Removes all the metadata instances for the specified nodes. | BIG-IP_v11.2.0 |
| remove_metadata | Removes the metadata for the specified nodes and names. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| reset_statistics | Resets the statistics for the specified node addresses. | BIG-IP_v11.0.0 |
| set_connection_limit | Sets the connection limits for a sequence of node addresses. Note that the limit data type was ULong64 in previous versions. | BIG-IP_v11.0.0 |
| set_default_node_monitor | Sets the default node monitor rule. If a node address is not explicitly assigned a monitor rule, the default node monitor rule is used to monitor the node address. A default node monitor that has been set can be canceled by setting the monitor rule type to MONITOR_RULE_TYPE_NONE. | BIG-IP_v11.0.0 |
| set_description | Sets the description for a set of node addresses. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_dynamic_ratio | This method is deprecated because dynamic ratio can be ULong, not just UShort. Please use set_dynamic_ratio_v2. Sets the dynamic ratios for the specified node addresses. | BIG-IP_v11.0.0 |
| set_dynamic_ratio_v2 | Sets the dynamic ratios for the specified node addresses. | BIG-IP_v11.3.0 |
| set_metadata_description | Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_persistence | Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_value | Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_monitor_logging_state | Sets the node for monitor logging. All the monitors applied to the node will log its actions to a unique file located in /var/log/monitors/*.log. Logs are rotated and compressed periodically. | BIG-IP_v11.5.0 |
| set_monitor_rule | Sets the monitor rules for monitoring the health of the specified node addresses. Monitoring can be turned off for an individual node by setting the monitor rule type to MONITOR_RULE_TYPE_NONE. This overrides any default node monitor set. Monitoring can be restored to the default node monitor for an individual node by setting the monitor rule type to MONITOR_RULE_TYPE_SINGLE and using a name of “” (empty name). | BIG-IP_v11.0.0 |
| set_monitor_state | Sets the availability states for a sequence of node addresses, either enabled/disabled or up/down. | BIG-IP_v11.0.0 |
| set_rate_limit | Sets the rate limits for a sequence of node addresses. | BIG-IP_v11.2.1 |
| set_ratio | Sets the ratios for the specified node addresses. | BIG-IP_v11.0.0 |
| set_session_enabled_state | Sets the states that allows new sessions to be established for the specified node addresses. | BIG-IP_v11.0.0 |
Structures¶
Structure
Description
A struct that describes statistics for a particular node address.
A struct that describes Node address statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| NodeAddressStatisticEntrySequence | NodeAddressStatisticEntry [] | A sequence of Node address statistics. |
See Also¶
iControl ::
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.