cm device¶

cm device(1) BIG-IP TMSH Manual cm device(1)

NAME
device - Manages a device.

MODULE
cm

SYNTAX
Manage the device component within the cm module using the syntax shown in the following sections. The 'create cm device'
and 'delete cm device' commands are deprecated beginning version 13.0.0.

MODIFY
modify device [name]
options:
comment [string]
configsync-ip [ip address | none]
contact [string]
description [string]
ha-capacity [integer]
location [string]
mgmt-unicast-mode [ both | ipv4 | ipv6 ]
mirror-ip [ip address | any6]
mirror-secondary-ip [ip address | any6]
multicast-interface [string]
multicast-ip [ip address]
multicast-port [integer]
unicast-address [ none | {
{
ip [ip address]
port [port number]
effective-ip [ip address]
effective-port [port number]
}
...
}
]

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

DISPLAY
list device
list device [ [ [name] | [glob] | [regex] ] ... ]
show running-config device
show running-config device [ [ [name] | [glob] | [regex] ] ... ]
options:
active-modules
all-properties
app-service
base-mac
build
cert
chassis-id
chassis-type
failover-stats
hostname
inactive-modules
key
location
management-ip
marketing-name
non-default-properties
one-line
optional-modules
partition
platform-id
product
recursive
self-device
time-limited-modules
time-zone
version

show device-group
show device-group [name]
options:
all
field-fmt

DESCRIPTION
You can use the device component to manage devices.

Warning: To add or remove devices on the BIG-IP system, modify the Root trust domain. For more information, see help trust-
domain.

OPTIONS
active-modules
Displays the licensed modules that are currently active on the device.

app-service
Displays 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 the object. Only the Application
Service can modify the object.

base-mac
Displays the base MAC address for the device.

build
Displays the software build number.

cert Displays the identity certificate used for device trust.

chassis-id
Displays the chassis identifier.

chassis-type
Displays the chassis type. The possible values are individual and viprion.

comment
Specifies user comments about the device.

configsync-ip
Specifies the IP address used for configuration synchronization. If you specify a self IP address, the self IP address
object must be located in the Common folder.

contact
Specifies administrator contact information.

description
Specifies a user-defined description of the device.

edition
Displays the software edition.

failover-state
Displays the device failover state.

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

ha-capacity
Specifies a number that represents the relative capacity of the device to be active for a number of traffic groups.
This value along with the traffic group's ha-load-factor is used by the failover daemon to make traffic groups active
amongst the available devices. The value is zero by default which means the device may run any number of traffic
groups. The value must be within a valid range: 0 - 100000 inclusive.

hostname
Displays the hostname of the device.

inactive-modules
Displays the licensed modules that are currently inactive on the device.

key Displays the identity key used for device trust.

location
Specifies the physical location of the device.

marketing-name
Displays the marketing name of the device platform.

mgmt-unicast-mode
When a management-ip is added as a failover unicast address; this attribute allows to specify using only an specific
family instead of the default both.

mirror-ip
Specifies the IP address used for state mirroring. If you specify a self IP address, the self IP address object must
be located in the Common folder.

mirror-secondary-ip
Specifies the secondary IP address used for state mirroring. If you specify a self IP address, the self IP address
object must be located in the Common folder.

multicast-interface
Specifies the interface name used for the failover multicast IP address.

multicast-ip
Specifies the multicast IP address used for failover.

multicast-port
Specifies the multicast port used for failover.

optional-modules
Displays the modules that are available for the current platform, but are not currently licensed.

platform-id
Displays the device platform identifier.

product
Displays the software product name.

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

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.

self-device
Displays true, when the device is the self device.

time-limited-modules
Displays the licensed modules that are time-limited.

time-zone
Displays the time zone configured on the device.

unicast-address
If present, specifies the entire set of unicast addresses used for failover, and replaces all previous unicast
addresses. The keyword none may be used to remove all unicast addresses.

Multiple unicast addresses may be specified, each of which has an ip, port, effective-ip, and effective-port.

Each unicast-address when specified has the following parameters:

ip The IP address that the failover daemon will listen on for packets from its peers. This address must be a non-
floating self-IP or a management address.

The keyword management-ip may be used to specify that the current addresses of the device management interface
are used. The mgmt-unicast-mode will narrow down the selection based on the address family.

port The IP port that the failover daemon uses to accept packets from its peers. If not specified, 1026 will be
used.

effective-ip
The IP address that peers can use to reach this unicast address IP. This option is only needed if a address-
translating firewall exists between the peer BIG-IPs. If not present, the effective-ip is the same as the ip.

effective-port
The port that peers can use to reach this unicast address. This option is only needed if a port-translating
firewall exists between the peer BIG-IPs. If not present, the effective-port is the same as the port.

version
Displays the software version number.

SEE ALSO
edit, glob, list, modify, mv, regex, show, tmsh, trust-domain

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 2017-10-25 cm device(1)