cm traffic-group¶

cm traffic-group(1) BIG-IP TMSH Manual cm traffic-group(1)

NAME
traffic-group - Manages a CM traffic group.

MODULE
cm

SYNTAX
Manage the traffic-group component within the cm module using the syntax shown in the following sections.

CREATE/MODIFY
create traffic-group [name]
modify traffic-group [name]
options:
app-service [[string] | none]
auto-failback-enabled [ enabled | disabled ]
auto-failback-time [ integer ]
description [string ]
failover-method [ ha-score | ha-order ]
ha-group [string]
ha-load-factor [ integer ]
ha-order [ string ... ]
mac [mac address
monitor { ha-group [string] }

edit traffic-group [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties

DISPLAY
list traffic-group
list traffic-group [ [ [name] | [glob] | [regex] ] ... ]
show running-config traffic-group
show running-config traffic-group [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
app-service
is-floating
non-default-properties
one-line
partition
recursive
unit-id [integer]

show traffic-group
show traffic-group [name]
options:
all-properties
details
failover-objects
field-fmt

DELETE
delete traffic-group [name]

DESCRIPTION
You can use the traffic-group component to specify the failover behavior for devices in a failover device group.

EXAMPLES
create traffic-group my_traffic_group

Creates a traffic group named my_traffic_group.

create traffic-group my_traffic_group ha-order { my_device }

Creates a traffic group named my_traffic_group with a preferred device named my_device.

OPTIONS
app-service
Specifies the application service to which the object 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 object. Only the
Application Service can modify or delete the object.

auto-failback-enabled
Specifies whether the traffic group fails back to the default device.

auto-failback-time
Specifies the time required to fail back. The value must be within a valid range: 0 - 300 inclusive.

details
Only usable with the show command. Displays the active or next-active devices for this traffic group.

failover-method
Specifies the method used to decide if the current device needs to failover the traffic-group to another device. If
the failover-method is set to ha-score, a score is calculated for each device in the monitoring HA group; and the
highest score is the current active device while the next highest score will be the device that takes over if the
current one fails. If the failover-method is set to ha-order, a list of devices and their respective HA load is used
to decide the next one to take over if the current devices fails.

failover-objects
Only usable with the show command. Tells it to display all of the objects associated with that traffic group.

ha-group
Deprecated since v13.0.0. Use monitor and failover-method instead. This specifies a ha-group for the traffic group to
decide the active device within the traffic group. The HA group must exist first. Note: This attribute is only
specific to the local device i.e. not sync'ed to its peers in the traffic group. If you use this deprecated command
attribute, it will also set the failover-method to ha-score.

ha-order
This list of devices specifies the order in which the devices will become active for the traffic group when a failure
occurs. This list may contain zero, one or more entries up to the number of devices in the failover device group. If
auto-failback enabled is set to true, this list must contain at least one entry for the auto-failback device.

ha-load-factor
Specifies a number for this traffic group that represents the load this traffic group presents to the system relative
to other traffic groups. This allows the failover daemon to load balance the active traffic groups amongst the
devices. The value is one by default. The value must be within a valid range: 1 - 1000 inclusive.

monitor { ha-group [string] }
This specifies a ha-group monitor for the traffic group to decide the active device within the traffic group. The HA
group must exist first. Note: This attribute is only specific to the local device i.e. not sync'ed to its peers in the
traffic group.

description
Specifies a user-defined description.

glob Displays the items that match the glob expression. See help glob for a description of glob expression syntax.

is-floating
Indicates whether the traffic group can fail over to other devices in the device group.

mac Specifies a MAC address for the traffic group.

partition
Displays the administrative partition within which the device group 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.

recursive
Displays all objects of the specified type and the folder that contains the object.

unit_id
Displays the unit ID for the traffic group. The unit ID is set automatically when you create a traffic group. The
value is between 1 and 15.

SEE ALSO
create, delete, edit, glob, list, modify, regex, 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.

BIG-IP 2016-10-04 cm traffic-group(1)