ltm virtual-address
ltm virtual-address(1) BIG-IP TMSH Manual ltm virtual-address(1)
NAME
virtual-address - Configures virtual addresses.
MODULE
ltm
SYNTAX
Configure the virtual-address component within the ltm module using the syntax shown in the following
sections.
CREATE/MODIFY
create virtual address [name]
modify virtual address [name]
options:
address [ip address]
app-service [[string] | none]
arp [enabled | disabled]
auto-delete [true | false]
connection-limit [integer]
description [string]
enabled [yes | no]
icmp-echo [enabled | disabled | selective | always | any | all]
mask [netmask]
route-advertisement [enabled | disabled | selective | always | any | all]
server-scope [all | any | none]
spanning [enabled | disabled]
traffic-group [[string] | default | non-default | none]
metadata
[add | delete | modify] {
[metadata_name ... ] {
value [ "value content" ]
persist [ true | false ]
}
}
edit virtual-address [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
reset-stats virtual-address
reset-stats virtual-address [ [ [name] | [glob] | [regex] ] ... ]
mv virtual-address [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
DISPLAY
list virtual-address
list virtual-address [ [ [name] | [glob] | [regex] ] ... ]
show running-config virtual-address
show running-config virtual-address
[ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show virtual-address
show virtual-address [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
detail
field-fmt
DELETE
delete virtual-address [all | [name]]
DESCRIPTION
You can use the virtual-address component to enable, disable, display, and delete virtual addresses. You can
also list the virtual address configuration, and view statistics for a specific virtual address.
Note that tmsh only displays virtual addresses when you explicitly request them. For example:
To display the properties of virtual addresses or a specific virtual address from the ltm module, use the
command sequences list virtual-address and list virtual-address [name], respectively.
To display statistics for virtual addresses or a specific virtual address from the ltm module, use the command
sequence show virtual-address and show virtual-address [name], respectively.
EXAMPLES
create virtual-address myVirtualAddr address 10.10.10.20 enabled yes
Creates a virtual address 10.10.10.20, with a name of myVirtualAddr.
create virtual-address myVirtualAddr address 10.10.10.20 enabled yes traffic-group /Common/traffic-group-1
Creates a virtual address 10.10.10.20, with a name of myVirtualAddr, that is assigned to traffic-group-1.
modify virtual-address myVirtualAddr enabled no
Disables the virtual address myVirtualAddr.
delete virtual-address myVirtualAddr
Deletes the virtual address myVirtualAddr.
list virtual-address myVirtualAddr all-properties
Lists the configuration information for the virtual address, myVirtualAddr.
show virtual-address myVirtualAddr
Displays statistics and status for the virtual-address myVirtualAddr.
show virtual-address myVirtualAddr all-properties
Displays statistics and status for the virtual named myVirtualAddr.
Note that if the system includes Packet Velocity(r) ASIC (PVA) and PVA Assist capabilities, this command
displays status and statistics for that feature.
mv /ltm virtual-address /Common/10.10.10.20 to-folder /Common/all_virtual_addresses
Moves the virtual-address 10.10.10.20 to a folder named all_virtual_addresses.
Note: If you wish to change the name of the virtual-address, you must use the configured IP Address or a name
that does not represent a different IP Address than the one configured.
Please refer to the mv manual page for additional examples on how to use the mv command.
OPTIONS
address
The virtual IP address.
arp Enables or disables ARP for the specified virtual address. The default value is enabled.
app-service
Specifies the name of the application service to which the virtual address 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 virtual address. Only the application service can modify or delete the
virtual address.
auto-delete
Indicates if the virtual address will be deleted automatically on deletion of the last associated virtual
server or not. The default value is true.
connection-limit
Sets a concurrent connection limit for one or more virtual servers. The default value is 0, meaning "no
limit."
description
User defined description.
enabled
Specifies whether the specified virtual address is enabled. The default value is yes.
floating
Read-only property derived from traffic-group. A floating virtual address is a virtual address for a VLAN
that serves as a shared address by all devices of a BIG-IP traffic-group.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
icmp-echo
Specifies whether the virtual address should reply to ICMP echo requests. The default value is enabled.
enabled or always
ICMP echo reply will be sent in response to ICMP echo requests.
disabled
ICMP echo reply will not be sent in response to ICMP echo requests.
selective
ICMP echo reply will sent be in response to ICMP echo requests, when availability status is true.
any ICMP echo reply will be sent in response to ICMP echo requests, when any of the contributing virtual
server is available.
all ICMP echo reply will be sent in response to ICMP echo requests when all of the contributing virtual
server is available.
mask Sets the netmask for one or more network virtual servers only. This setting is required for network
virtual servers. The default value is 255.255.255.255.
partition
Displays the administrative partition within which the virtual address resides.
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.
route-advertisement
Specifies the route advertisement setting for the virtual address. The default value is disabled.
enabled or selective
Route is advertised when virtual-address is available.
disabled
Route is not advertised.
always
Route is advertised regardless of the availability status.
any Route is advertised when any of the contributing virtual server is available.
all Route is advertised when all of the contributing virtual server is available.
server-scope
Specifies when the virtual address is considered available. When a virtual address is available and Route
Advertisement is enabled or selective, the BIG-IP system advertises the route for the virtual address.
The default value is any.
any When any virtual server is available: Advertises the route when any virtual server is available.
all When all virtual servers are available: Advertises the route when all virtual servers are available.
none Always advertises the route regardless of the virtual servers available.
spanning
Enables or disables spanning for the specified virtual address. The default value is disabled.
unit Read-only property that specifies the unit in a redundant system. Based on traffic-group.
traffic-group
Specifies the traffic group on which the virtual address is active. The default traffic group is
inherited from the containing folder.
inherited-traffic-group
Read-only property that indicates if the traffic-group is inherited from the parent folder.
metadata
Associates user defined data, each of which has name and value pair and persistence. Persistent(default)
means the data will be saved into config file.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, 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-2013. All rights reserved.
BIG-IP 2018-03-06 ltm virtual-address(1)