APIRef_tm_ltm_node¶
mgmt/tm/ltm/node
Node specific pool member configuration
REST Endpoints
- Collection URI
/mgmt/tm/ltm/node- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/node/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
address |
string | optional | read/write | IP address of the node. This is an optional field; if empty, the name needs to be of the form ip address | |
appService |
string | optional | read/write | The application service to which the object belongs. | |
connectionLimit |
integer | 0 | optional | read/write | Specifies the maximum number of connections allowed for the node or node address. |
description |
string | optional | read/write | User defined description. | |
dynamicRatio |
integer | 1 | optional | read/write | Sets the dynamic ratio number for the node. Used for dynamic ratio load balancing. The ratio weights are based on continuous monitoring of the servers and are therefore continually changing. Dynamic Ratio load balancing may currently be implemented on RealNetworks RealServer platforms, on Windows platforms equipped with Windows Management Instrumentation (WMI), or on a server equipped with either the UC Davis SNMP agent or Windows 2000 Server SNMP agent. |
ephemeral |
string | false | optional | read | |
logging |
string | disabled | optional | read/write | Specifies whether the node’s monitor(s) actions will be logged. Logs are stored in /var/log/monitors/ |
monitor |
string | optional | read/write | Specifies the name of the monitor or monitor rule that you want to associate with the node. | |
tmPartition |
string | Common | optional | read/write | Displays the administrative partition within which this node resides. |
rateLimit |
string | 0 | optional | read/write | Specifies the maximum number of connections per second allowed for a node or node address. The default value is ‘disabled’. |
ratio |
integer | 1 | optional | read/write | Specifies the fixed ratio value used for a node during ratio load balancing. |
session |
string | user-enabled | optional | read/write | Enables or disables the node for new sessions. The default value is user-enabled. |
state |
string | optional | read/write | Marks the node up or down. The default value is user-up. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/fqdn |
array_structure | optional | read/write | ||
/fqdn/address-family |
string | ipv4 | optional | read/write | Specifies the node’s address family. The default is ‘unspecified’, or IP-agnostic |
/fqdn/autopopulate |
string | disabled | optional | read/write | Specifies whether the node should scale to the IP address set returned by DNS. |
/fqdn/down-interval |
integer | 5 | optional | read/write | Specifies the number of attempts to resolve a domain name. The default is 5. |
/fqdn/interval |
string | 3600 | optional | read/write | Specifies the amount of time before sending the next DNS query. |
/fqdn/name |
string | optional | read/write | Specifies the fully qualified domain name of the node. | |
/fqdn/address-family |
string | ipv4 | optional | read/write | Specifies the node’s address family. The default is ‘unspecified’, or IP-agnostic |
/fqdn/autopopulate |
string | disabled | optional | read/write | Specifies whether the node should scale to the IP address set returned by DNS. |
/fqdn/down-interval |
integer | 5 | optional | read/write | Specifies the number of attempts to resolve a domain name. The default is 5. |
/fqdn/interval |
string | 3600 | optional | read/write | Specifies the amount of time before sending the next DNS query. |
/fqdn/name |
string | optional | read/write | Specifies the fully qualified domain name of the node. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/metadata |
array_structure | optional | read/write | ||
/metadata/app-service |
string | optional | read/write | ||
/metadata/persist |
string | true | optional | read/write | |
/metadata/value |
string | optional | read/write |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.