ltm node
ltm node(1) BIG-IP TMSH Manual ltm node(1)
NAME
node - Configures node addresses and services.
MODULE
ltm
SYNTAX
Configure the node component within the ltm module using the syntax in
the following sections.
CREATE/MODIFY
create node [name]
modify node [name]
options:
address [ip address]
app-service [[string] | none]
connection-limit [integer]
description [string]
[down | up]
dynamic-ratio [integer]
fqdn {
name [string]
address-family [ipv4 | ipv6]
autopopulate [enabled | disabled]
down-interval [integer]
interval [integer]
}
logging [enabled | disabled]
monitor [ [name] | none]
rate-limit [integer]
ratio [integer]
session [user-enabled | user-disabled]
state [user-down | user-up]
metadata
[add | delete | modify] {
[metadata_name ... ] {
value [ "value content" ]
persist [ true | false ]
}
}
reset-stats node
reset-stats node [ [ [ip address] | [glob] | [regex] ] ... ]
edit node [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv node [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
DISPLAY
list node
list node [ [ [name] | [glob] | [regex] ] ... ]
show running-config node
show running-config node [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show node
show node [name]
options:
all-properties
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
DELETE
delete node [name]
DESCRIPTION
Displays information about nodes, and sets attributes of nodes and node
IP addresses.
EXAMPLES
list node all-properties
Displays all of the properties of all of the nodes.
modify node all monitor none
Removes all monitor associations from nodes.
create node myNode address 10.10.10.15
Creates a node named myNode with an IP address of 10.10.10.15.
modify node myNode monitor none
Removes all monitor associations from the node, myNode.
show node
Displays statistics and status for all nodes in the system
configuration.
show node all-properties
Displays statistics and status for all nodes in the system
configuration. If the system includes Packet Velocity(r) ASIC (PVA) and
PVA Assist capabilities, this command displays status and statistics
for that feature.
mv /ltm node /Common/10.10.10.15 to-folder /Common/all_nodes
Moves the node 10.10.10.15 to a folder named all_nodes, where all_nodes
has already been created under /Common.
Note: If you wish to change the name of the node, you must use the
nodes same IP Address or a name that does not represent an IP Address
that does not match the address configured on the node.
Please refer to the mv manual page for additional examples on how to
use the mv command.
OPTIONS
address
Specifies the IP address of the node.
app-service
Specifies the name of the application service to which the node
belongs. The default value is none. Note: If the strict-updates
option is enabled on the application service that owns the object,
you cannot modify or delete the node. Only the application service
can modify or delete the node.
connection-limit
Specifies the maximum number of connections that a node or node
address can handle. The default value is 0 (zero).
description
Specifies a user-defined description.
[down | up]
Marks the node up or down. The default value is down.
dynamic ratio
Sets the dynamic ratio number for the node. The ratio weights are
based on continuous monitoring of the servers and are therefore
continually changing. The default value is 1.
Dynamic Ratio load balancing can 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.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
metadata
Associates user defined data, each of which has a name and value
pair and persistence. The default value is persistent, which saves
the data to the config file.
fqdn Specifies the attributes for defining a fully qualified domain
name for the node.
name Specifies the fully-qualified domain name of the node.
address-family
Specifies whether the fqdn should consider IPv4, IPv6, or IP-
agnostic address family.
autopopulate
Specifies whether a node defined by a fully-qualified domain
name should automatically scale to the set of IP addresses
returned by the DNS query. If disabled, only one ephemeral
node is generated from the first IP address returned by DNS.
The default is disabled.
interval
Specifies the interval, in seconds, to instantiate DNS
queries on a fully-qualified domain name. The default is
3600. A value of 'ttl' uses the TTL value obtained from the
DNS server.
down-interval
Specifies the interval for the domain name resolution
operation when a DNS query fails. The default is 5.
logging
Specifies whether the monitor applied should log its actions. Logs
are stored in /var/log/monitors/ and are regularly rotated and
compressed. The default value is disabled. This option isn't a
part of configuration and will reset to disabled on load. This
option doesn't sync.
monitor
Specifies the name of the monitor that you want to associate with
the node. The default value is none.
partition
Displays the administrative partition in which the node object
resides.
rate-limit
Specifies the maximum number of connections per second allowed for
a node or node address. The default value is 'disabled'.
ratio
Specifies the fixed ratio value used for a node during Ratio load
balancing. The default value is 1.
regex
Displays the items that match the regular expression. The regular
expression must be preceded by an at sign (@[regular expression])
to indicate that the identifier is a regular expression. See help
regex for a description of regular expression syntax.
session
Establishing a session with a node is establishing the ability of
the client to persist to the node when making new connections.
When a node is session disabled, clients that have already
established sessions with the node may create new connections, but
a client that has not already established a session may not create
a new one (or make a connection which would create a new session).
This feature is used to gently drain connections from a node,
typically as part of a maintenance operation. The default value is
user-enabled.
state
Specifies the current state of the node. Use user-down to indicate
that the node may not handle any new connections. Use user-up,
after using user-down, to indicate that the node may accept new
connections.
to-folder
This is used with the mv command to specify a folder in which to
move the node to.
Note: nodes can be moved to any folder under /Common, but
dependencies upon it may restrict moving it out of /Common.
SEE ALSO
create, delete, edit, glob, list, ltm pool, modify, mv, regex, reset-
stats, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying,
recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, without the express
written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2012-2015. All rights
reserved.
BIG-IP 2018-10-17 ltm node(1)