edit¶

edit(1) BIG-IP TMSH Manual edit(1)

NAME
edit command - Opens the specified components in an editor.

MODULES
All tmsh modules.

SYNTAX
Use the command edit to create components or modify the configuration of components using a text editor. To edit a
component that resides in another module, use the full path to the component.

edit [component] [name ... name | all]
edit / [module...module] [component] [name ... name | all]

DESCRIPTION
You can use the command edit to create or modify components in the auth, cli, gtm, ltm, net, sys and wom modules, and
iRules(r).

If you are assigned the role of Administrator, when you use the command edit, the system starts the vi editor. If you are
assigned any other role, the system starts the pico/nano editor.

The system saves, in a temporary directory, the text file, named data, that you are editing. When you save the file and
close the editor, the system checks for errors, and then prompts you with an opportunity to continue editing and resolve
any errors.

When you edit an existing component that can have associations, such as a Global Traffic Manager wide IP that can have pool
member associations. but the component does not currently have associations, to create the new associations, you must use
the full command syntax in the text file. For the full command syntax for each component, see the associated man page.

When you edit a component that has associations with components that are children of the component you are editing, the
text file contains a line for the configuration of the child components that begins with the command modify, for example:
pools modify { [existing pool members configurations] }. In this case, if you want to add or delete pool members, you must
add additional lines to the text file, for example: pools delete { [pool members to delete] }.

If you want the text file that opens to contain all of the editable properties of the component that you want to edit, you
must use the all-properties option at the end of the edit command sequence; otherwise, only the non-default properties
display in the text file.

EXAMPLES
edit / gtm pool a*

From the root module, opens a file in an editor in which you can modify the configuration of all Global Traffic Manager
pools with names that start with the letter a using the template that displays in the editor.

edit datacenter new_dc

From the gtm module, opens a file in an editor in which you can create the Data Center named new_dc using the template that
displays in the editor.

edit datacenter a*

From the gtm module, opens a file in an editor in which you can edit all existing datacenters with names that begin with
the letter a.

edit datacenter new_datacenter existing_datacenter

From the gtm module, opens a file in an editor in which you can create a new datacenter and edit an existing datacenter.
Note that when the file opens, a template displays that you can use to create a new datacenter followed by the
configuration of the existing datacenter.

edit rule rule_1

From the gtm module, opens a file in an editor in which you can create an iRule named rule_1 using the template that
displays in the editor.

When the editor opens, and you are creating or editing an iRule, you must enclose the iRule syntax in brackets, for
example, [ ...iRule... ]. Note that the template includes the brackets.

OPTIONS
all Specifies that you want to modify all of the existing components of the specified type.

component
Specifies the type of component that you want to create or modify.

module
Specifies the module within which the component resides.

name Specifies a unique name of each component that you want to create or modify.