cm device-groupΒΆ

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

NAME
       device-group - Configures device groups.  The device groups that are created and maintained by the system cannot be
       modified by the user.

MODULE
       cm

SYNTAX
       Modify the device-group component within the cm module using the syntax shown in the following sections.

   CREATE/MODIFY
	create device-group [name]
	modify device-group [name]
	 options:
	  app-service [[string] | none]
	  asm-sync [ enabled | disabled ]
	  auto-sync [ enabled | disabled ]
	  description [string]
	  devices [add | delete | modify | replace-all-with] {
	      [ device_name ]
	  }
	  full-load-on-sync [true | false]
	  incremental-config-sync-size-max [integer]
	  network-failover [ enabled | disabled ]
	  save-on-auto-sync [true | false]
	  type [ sync-only | sync-failover ]
	  clear-incremental-config-sync-cache

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

   DISPLAY
	list device-group
	list device-group [ [ [name] | [glob] | [regex] ] ... ]
	show running-config device-group
	show running-config device-group [ [ [name] | [glob] | [regex] ] ... ]
	 options:
	  all-properties
	  app-service
	  non-default-properties
	  partition
	  recursive

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

   DELETE
	delete device-group [name]

       Note: The device group must be empty, and you must remove all references to the device group, before you can delete the
       device group.

DESCRIPTION
       You can use the device-group component to manage sets of devices used for configuration synchronization and failover.

EXAMPLES
       create device-group my_device_group devices add {
	   /Common/device1
	   /Common/device2
	   }

       Creates a sync-only device group named my_device_group with two devices, device1 and device2.

       delete device-group my_device_group

       Deletes the device group named my_device_group.

       list device-group my_device_group

       Displays properties of the device group named my_device_group.

       modify device-group my_device_group clear-incremental-config-sync-cache

       Warning: Do not use this option without assistance from the F5 Technical Support team.

       Clears the incremental configuration synchronization cache. The next configuration synchronization for my_device_group that
       pulls configuration from this device will be a full load.

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.

       asm-sync
	    Specifies whether to synchronize ASM configurations of device group members. The default value is disabled. A device
	    can be a member of only one ASM-enabled device group.

       auto-sync
	    Specifies whether the device group automatically synchronizes configuration data to its members. The default value is
	    disabled. Configuration will be saved on remote devices after receiving configuration updates if save-on-auto-sync is
	    enabled.

       clear-incremental-config-sync-cache
	    Warning: Do not use this option without assistance from the F5 Technical Support team.

	    The incremental configuration synchronization mechanism keeps a cache of transactions in each device group. Specifying
	    this option will remove all transactions from the cache for the given device groups. This will not remove
	    configuration from the device group, but will cause the next load in that group from the current device to be a full
	    load.

       description
	    Specifies a user-defined description of the device group.

       devices
	    Adds, deletes, or replaces a set of devices to a device group by specifying the device name(s). When the local device
	    is removed from a device group then all of the sys folders that are associated with the device group are reset to have
	    no device group and the name of each folder that was updated is logged to /var/log/ltm.

       full-load-on-sync
	    Specifies that the entire configuration for a device group is sent when configuration synchronization is performed.
	    The default value is false.

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

       incremental-config-sync-size-max
	    Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
	    Valid range is between 128 and 10240."

       name Specifies a unique name for the component. This option is required for the commands create, delete, and modify.

       network-failover
	    When the device group type is failover, specifies whether network failover is used.

       partition
	    Displays the administrative partition within which the device group resides.

       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.

       save-on-auto-sync
	    Specifies whether to save the configuration on the remote devices following an automatic configuration
	    synchronization. A device group configured for manual synchronization will always save on the remote devices
	    regardless of this setting.

       type Specifies the type of device group. You can use this option only when you create a device group. You cannot modify the
	    type of a device group. The default value is sync-only.

SEE ALSO
       create, delete, device, 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.

       F5 Networks and BIG-IP (c) Copyright 2008-2013. All rights reserved.

BIG-IP							    2017-05-25						cm device-group(1)