APIRef_tm_cm_deviceΒΆ
mgmt/tm/cm/device
Device configuration
REST Endpoints
- Collection URI
/mgmt/tm/cm/device- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/cm/device/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
activeModules |
string | optional | read/write | Active modules that are currently licensed | |
appService |
string | optional | read/write | The application service that the object belongs to. | |
baseMac |
string | optional | read/write | Base MAC address for the device | |
build |
string | optional | read/write | Software build number | |
cert |
string | optional | read/write | Identity certificate used for device trust; only set on self device. | |
chassisId |
string | optional | read/write | Chassis identifier | |
chassisType |
string | individual | optional | read/write | Chassis type, values are individual and viprion |
comment |
string | optional | read/write | User defined comment | |
configsyncIp |
string | optional | read/write | IP address used for config sync | |
contact |
string | optional | read/write | User defined contact information | |
description |
string | optional | read/write | User defined description | |
edition |
string | optional | read/write | Software edition | |
failoverState |
string | unknown | optional | read/write | Device failover state |
haCapacity |
integer | 0 | optional | read/write | Device capacity for being active for a number of traffic groups |
hostname |
string | optional | read/write | Device hostname | |
inactiveModules |
string | optional | read/write | Licensed modules that are currently inactive | |
key |
string | optional | read/write | Identity key used for device trust; only set on self device. | |
location |
string | optional | read/write | User defined location | |
managementIp |
string | required | read/write | Management IP Address of the device | |
marketingName |
string | optional | read/write | Marketing name of the device platform | |
mirrorIp |
string | optional | read/write | IP address used for state mirroring | |
mirrorSecondaryIp |
string | optional | read/write | Secondary IP address used for state mirroring | |
multicastInterface |
string | optional | read/write | The interface name for the failover multicast address | |
multicastIp |
string | optional | read/write | Multicast IP address used for failover | |
multicastPort |
integer | optional | read/write | Multicast port used for failover | |
optionalModules |
string | optional | read/write | Modules available for the current platform but not currently licensed. | |
tmPartition |
string | Common | optional | read/write | Device administrative partition |
platformId |
string | optional | read/write | Device platform identifier | |
product |
string | optional | read/write | Software product name | |
selfDevice |
string | false | optional | read/write | Set to B<true> when the device is the self device |
timeLimitedModules |
string | optional | read/write | Licensed modules that are time-limited | |
timeZone |
string | optional | read/write | Time zone for the device | |
unicastAddress |
string | optional | read/write | Set of unicast addresses used for failover | |
version |
string | optional | read/write | Software version number |
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.