sys ucs

sys ucs(1)					  BIG-IP TMSH Manual					   sys ucs(1)

NAME
       ucs - Loads or saves a UCS (.ucs) file.

MODULE
       sys

SYNTAX
       Configure the ucs component within the sys module using the syntax in the following sections.

   MODIFY
	save ucs [file name]
	  options:
	    no-private-key
	    passphrase

	load ucs [file name]
	  options:
	    include-chassis-level-config
	    no-license
	    no-platform-check
	    passphrase
	    platform-migrate
	    reset-trust

	delete ucs [ file name ]

   DISPLAY
	list ucs
	show ucs [file name]

DESCRIPTION
       You can use the ucs component to save the running configuration of the system into a UCS file. Additionally,
       you can modify the running configuration of the system by loading an existing UCS file.

       When you save a UCS file, the file is saved to the default directory, /var/local/ucs.

       When you load a UCS file in shell mode, the system searches for the file using the relative path to the
       default directory (/var/local/ucs). When you load a UCS file in bash mode, the system searches the current
       directory first. If the file is not found in the current directory, the default directory is then searched.

EXAMPLES
       save ucs myucs

       Saves the running configuration of the system into the file myucs.ucs.

       load ucs myucs

       Modifies the running configuration of the system by loading the configuration contained in the myucs.ucs file.

       delete ucs myucs

       Delete myucs.ucs in the default directory, /var/local/ucs/.

       list ucs

       Displays existing UCS files in the default directory, /var/local/ucs/.

OPTIONS
       include-chassis-level-config
	    During restore of the UCS file, include chassis level configuration that is shared among boot volume
	    sets. For example, cluster default configuration.

       no-license
	    Performs a full restore of the UCS file and all the files it contains, with the exception of the license
	    file. The option must be used to restore a UCS on RMA devices (Returned Materials Authorization).

       no-platform-check
	    Bypasses the platform check and allows a UCS that was created using a different platform to be installed.
	    By default (without this option), a UCS created from a different platform is not allowed to be installed.

       no-private-key
	    Indicates that the UCS file can be saved without private key information.

       passphrase
	    Specifies the passphrase that is necessary to load the specified UCS file.

       platform-migrate
	    Ignore the configuration items specific to a particular platform. The platform-specific objects already
	    present on the device are not removed or modified. The ones included in the UCS archive are not loaded.

	    This option is not valid for UCS archives from systems provisioned with modules other than LTM and GTM.
	    If the UCS comes from a system running any release of TMOS version 10, only LTM (not GTM) is supported.

	    This option implies no-license and no-platform-check.

       reset-trust
	    When specified, the device and trust domain certs and keys are not loaded from the UCS. Instead, a new
	    set is regenerated.

SEE ALSO
       load, list, save, show, 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 2009-2014, 2016. All rights reserved.

BIG-IP						      2016-03-31					   sys ucs(1)