cli alias private

cli alias private(1)				  BIG-IP TMSH Manual				 cli alias private(1)

NAME
       private - Configures a user private alias.

MODULE
       cli alias

SYNTAX
       Configure the alias component within the cli alias module using the syntax in the following sections.

   CREATE/MODIFY
	create private [name]
	  options:
	    command [commandSyntax]
	    command ["command syntax"]
	    command "[command syntax]; [command syntax]; ..."
	    app-service [[string] | none]
	    description [string]

	edit private [name]
	  options:
	    all

	modify alias [name]
	  options:
	    command [commandSyntax]
	    command ["command syntax"]
	    command "[command syntax]; [command syntax]; ..."

   DISPLAY
	list private
	list alias [ [ [name] | [glob] | [regex] ] ...]
	show running-config private
	show running-config private [ [ [name] | [glob] | [regex] ] ...]
	  options:
	    all-properties
	    one-line
	    non-default-properties

   DELETE
	delete private [all | [name ... name] ]

DESCRIPTION
       You can use the private component to create a shortcut that runs a tmsh command sequence. The name of the
       private alias is what you type on the command line to run the command. If the command sequence for which you
       are creating an alias contains spaces, it must be enclosed in quotation marks. Command aliases are not case-
       sensitive.

       You can create a private alias that runs multiple commands by entering the command sequences separated by
       semi-colons.

       Private aliases can be used only by the user who created them.

       When a batch mode transaction is active, commands that operate on the private component are run immediately
       and are not added to the transaction.

       For more information about aliases, see the Traffic Management Shell (tmsh) Reference Guide.

EXAMPLES
       create private save command "save config"

       Creates an alias that saves the running configuration in the stored configuration files from anywhere within
       tmsh.

       create private  stats command "show /sys traffic"

       Creates an alias that displays traffic statistics from anywhere within tmsh.

       create private nodemonitor command "list /ltm node; list /ltm monitor"

       Creates an alias that displays the Local Traffic Manager nodes and monitors.

       create private myalias command "show /sys provision ; show /sys license"

       Creates an alias that displays license and provisioning information.

       create private ltmpool command "list /ltm pool"

       Creates an alias that displays the Local Traffic Manager pools from anywhere within tmsh.

OPTIONS
       command syntax
	    Specifies the command for which you are creating an alias. To create an alias that runs multiple
	    commands, enter the command sequences separated by semi-colons.

       app-service
	    Specifies the name of the application service to which the alias 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 alias. Only the application service can modify or delete the alias.

       description
	    Specifies the purpose of the alias. If you enable cli preference show-aliases, tmsh displays the
	    description in context-sensitive help (?).

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

       name Specifies a name for the alias. This is what you type in tmsh to run the command for which you are
	    creating an alias.

       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.

SEE ALSO
       create, delete, edit, glob, list, modify, regex, show, shared, 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-2012. All rights reserved.

BIG-IP						      2012-12-20				 cli alias private(1)