APIRef_tm_cm_device-groupΒΆ

mgmt/tm/cm/device-group

/tm/cm

Device-group configuration

REST Endpoints

Collection URI
/mgmt/tm/cm/device-group
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/cm/device-group/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service that the object belongs to.
asmSync string disabled optional read/write Specifies whether to synchronize ASM configurations of device group members.
autoSync string disabled optional read/write Specifies if the device-group will automatically sync configuration data to its members
description string   optional read/write User-defined description
fullLoadOnSync string false optional read/write Specifies if the device-group will perform a full-load upon sync
hidden string false optional read/write  
incrementalConfigSyncSizeMax integer 1024 optional read/write Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
networkFailover string enabled optional read/write Specifies if the device-group will use a network connection for failover
tmPartition string Common optional read/write Device administrative partition
saveOnAutoSync string false optional read/write Specifies whether the configuration should be saved upon auto-sync.
type string sync-only optional read/write Specifies if the device-group will be used for failover or resource syncing

Subcollections

Name Type Default Value Required Access Description
devices array_structure   optional read/write  
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.