Cisco VFrame Data Center 1.1 Administration Guide - Designing Templates [Cisco VFrame Data Center]

Table Of Contents

Designing Templates

Basic Templates

Understanding Basic Templates

Understanding Basic Template Components

Targets

Events

Macros

Variables

Aliases

Working with Basic Template Components

Changing Targets

Working with Events

Working with Macros

Working with Variables

Working with Aliases

Service Templates

Creating Service Network Templates—Basic Workflow

Understanding Service Network Templates

Service Network Template Elements

Service Network Template Design and Network Virtualization

Service Network Template States

Service Network Template Change Control

Creating a Service Network Template—Scenario

Create a Template

Mock Up CLI

Identify Variables and Variable Groups

Create Variables and Variable Groups

Create Variable Aliases

Create Macros

Assign Macros to Events and Targets

Validate Your Service Network Template

Save and Publish Your Service Network Template

Working with Service Network Templates

Creating and Modifying Service Network Templates

Validating Service Network Templates

Saving and Publishing Service Network Templates

Deleting Service Network Templates

Cloning Service Network Templates

Exporting and Importing Service Network Templates

Troubleshooting Service Network Template Design

Storage Manager Templates

Creating Storage Manager Templates and Storage Managers—Basic Workflow

Understanding Storage Manager Templates

Default Storage Manager Templates

User-Defined Storage Manager Templates

Storage Managers

Working with Storage Manager Templates and Storage Managers

Creating and Modifying Storage Manager Templates

Deleting Storage Manager Templates

Cloning Storage Manager Templates

Exporting and Importing Storage Manager Templates

Defining Storage Managers

LOM Manager Templates

Creating LOM Manager Templates and LOM Managers—Basic Workflow

Understanding LOM Manager Templates

Default LOM Manager Templates

User-Defined LOM Manager Templates

Working with LOM Manager Templates

Creating and Modifying LOM Manager Templates

Deleting LOM Manager Templates

Exporting and Importing LOM Manager Templates

Defining LOM Managers

Troubleshooting LOM Manager Templates

Template Design Reference

Templates Tab

Macro Map Tab

Properties Tab

Events Tab

Event Dialog Box

Event Ordering Dialog Box

Macro Assignments Tab

Macros/Variables/Aliases Dialog Box

Edit Macro Assignment Dialog Box

Supported Targets Tab

Template Validation Results Dialog Box

Storage Managers Tab

Storage Manager Dialog Box

Variables Tab (Storage Managers)

LOM Managers Tab

Variables Tab (LOM Managers)

LOM Manager Dialog Box

Designing Templates

VFrame enables you to create several types of templates. Although these templates have very different objectives and functions, they all share some of the same basic concepts and components. The following topics provide detailed information about these templates:

•Basic Templates

•Service Templates

•Storage Manager Templates

•LOM Manager Templates

Basic Templates

Although the purposes of service, storage, and LOM Manager templates are different, some basic components and concepts of template design are the same. Before creating specific templates, it is a good idea to understand these basic components and concepts. You then can proceed to create any type of template you need.

The following topics provide detailed information about basic template components and concepts:

•Understanding Basic Templates

•Working with Basic Template Components

Understanding Basic Templates

Templates do more than define resource types and network topologies as in the case of service network templates. Templates provide information so that VFrame knows what to do when a specific event occurs, for example, run a macro to configure a target device, manage a LOM station, obtain information about a storage array, or trigger another event.

Understanding a template's basic event flow helps you understand the components that you need to create in order to design a functioning template. Figure 11-1 shows this basic event flow.

Figure 11-1 Template Event Flow

In LOM and storage templates, you must create macros and associate them to the LOM and storage managers within the template. However, with service network templates, default macros (called system actions) are already attached to the resource types (Layer 2 switches, server groups, load balancers, and so on) that you add to the template. To better understand this concept, see the following illustrations, which show the event flows for a service network template that has one Layer 2 switch connected to a server group:

•Figure 11-2—Deploy Network Event Flow

•Figure 11-3—Undeploy Network Event Flow

•Figure 11-4—Verify Network Event Flow

Figure 11-2 Deploy Network Event Flow

Figure 11-3 Undeploy Network Event Flow

Figure 11-4 Verify Network Event Flow

Templates also provide flexibility through the use of variables and aliases. Variables provide a way to reuse macros in different networks by providing values that are applicable to the specific network. Aliases allow you to link variable values. In this way, you can assign a value to one variable, and the same value is automatically assigned to the linked variable.

All of these components are discussed in detail in Understanding Basic Template Components

Understanding Basic Template Components

Regardless of the type of template you want to create, most of the same basic components apply. The following topics describe these basic components:

•Targets

•Events

•Macros

•Variables

•Aliases

Targets

When you define targets, you define the attributes of the physical resources that are acquired when a service network is deployed. VFrame tries to locate physical resources that match the defined attributes. If VFrame cannot find such a resource, the deployment fails.

When you define a target, you start with the most basic definition of a logical element. Then, you qualify that definition by defining constraints and constraint values. You can think of constraints as resource types and constraint values as resource type values.

When you create a storage or LOM template, the constraint type and value are automatically selected for you. For storage templates, the constraint type is a storage manager type and the value is storage manager. For LOM Manager templates, the constraint type is a LOM manager type and the value is LOM manager.

For service network templates, several different constraint types and values exist. Each logical element has a constraint type and values associated with it, as shown in Table 11-1. For example, a constraint type might be FirewallType and its value Firewall Services Module Router Mode.

When you add a logical element to your template, the logical element has a default constraint type and value associated with it. You can use the default constraint type and value, or if other constraint types and values are available, change them to meet your needs.

Table 11-1 Default Constraint Types and Values

Type

Value

Firewall

•Firewall Service Module Transparent Mode

•Firewall Service Module Route Mode

Server load balancer

•Content Switch Module Route Mode

•Content Switch Module Transparent Mode

Switch

Catalyst 6500 series switch

At the most specific level, constraint types become targets. At this level, you can associate macros with targets so that when a specified event occurs, the associated macro runs. Sometimes targets can be a specific endpoint on a logical element, instead of the logical element itself. VFrame supports these three cases:

•SVI on Layer 3 switch block

•Layer 2 switch endpoint connecting to a server group

•EtherChannel endpoint on Layer 2 switch

Note VFrame does not support macros on Layer 2 switches; therefore, the resource type constraint tree is not displayed.

Events

Events are operations performed by the service network. VFrame provides defined events. However, for service network templates, you can create additional events to the ones provided by VFrame.

Events trigger system actions to be performed by VFrame. In addition, you can create macros and assign them to events. In this way, when an event happens, a system action and/or macro occurs.

System-defined events vary according to the type of template to which they apply:

•Service network template

–Deploy Network

–Undeploy Network

–Verify Network

–Enter Maintenance

–Exit Maintenance

–Start Server

–Stop Server

–Verify Server

–Start Server Group

–Stop Server Group

–Verify Server Group

–Incremental Change

–Synchronize CSM HA Configuration

–HAResume

–HAMaintenance

–Force Release of Network Resources

•Storage template

–Inventory

–Mask LUN

–Unmask LUN

•LOM template

–Inventory

–Power Server Off

–Power Server On

–Get Server Power Status

Macros

Macros are sets of commands or instructions that perform specific operations on target devices. There are two types of macros: default macros that VFrame provides (called system actions) and the macros that you create.

The commands used in macros depend on the target device with which it is interacting. For example, when configuring a VLAN on a Layer 2 switch, the commands embedded in the macro are Cisco IOS CLI commands. When instructing a LOM manager to power on a server, the commands are HP iLO commands, Dell DRAC commands, and so on.

VFrame uses macros to automatically make configuration changes on specified devices whenever a defined event occurs, such as when a service network is deployed or undeployed.

After you create a macro, you must assign the macro to an event and target. The target defines the precise entity on which the macro is run and the event defines the circumstances that trigger the macro.

For example, in the template shown in Figure 11-5, when this service network is deployed, a Deploy Network event occurs and the config_csm and add_realserver macros are executed. The first macro (config_csm) configures the Content Switching Module (CSM) on its designated target device, the CSM. The second macro (add_realserver) adds real servers on its designated target device, the CSM.

Figure 11-5 Macro Example

Macro Creation and Organization

You can create macros using VFrame or using your own XML editor. If you use an XML editor, you must import the macro into VFrame. After you import the macro, you can associate it with the desired target device in your template.

In VFrame, macro files that contain other macros are called macro file containers. Also, when you create an XML file containing one or more macros, the XML file is considered to be a macro file container.

In addition to the macros, macro file containers hold the variables that apply to all macros within the macro file container.

See Figure 11-6 for an example.

Figure 11-6 Example of Macro File Container

Macro Design Concepts

When designing macros, keep in mind the following considerations:

•Order of Commands

•Naming Logical Elements

•Sharing Devices and Global Network Policies

•Handling Responses to CLI Commands

•Auto-Correcting Macros

Order of Commands

Commands within macros are performed in exactly the order that they appear. Therefore, you must logically order the commands within macros. In addition, when you have a set of commands in a macro linked to a Deploy Network event and have the opposite commands in a macro linked to a Undeploy Network event, you must make sure that the commands are in the same order.

For example, the config_csm macro linked to the Deploy Network event has the following commands:
serverfarm f1
nat server 
no nat client
vserver vs1
virtual 10.20.221.100 
serverfarm f1 
persistent rebalance 
inservice 
The unconfig_csm macro linked to the Undeploy Network event must be in the following order:
no serverfarm f1
no vserver vs1
If the unconfig_csm macro has its commands in the reverse order, configuration information could remain on the service network. For example, if the serverfarm f1 command failed during configuration, then the server (vs1) is not configured. Therefore, when removing the configuration using the unconfig_csm macro, the no vserver vs1 might return an error and the no serverfarm f1 will not be executed on the device. The server farm f1 configuration still exists on the device, and this can affect subsequent logical networks that you try to deploy.

Naming Logical Elements

You must also make sure that you do not assign logical elements the same name in two or more service networks.

For example, if service network A runs the following commands:
probe theProbe http
	port 80
Later, service network B runs the following commands:
probe theProbe http
	port 443
The last started service network overwrites the previously started service network. Port 80 is overwritten with port. So, the previously started service network will fail. In addition, if both service networks have auto-correction enabled, they will both compete to correct each other.

In this example, the likelihood of this problem occurring might be lessened by creating a variable for the port number. Then, when setting up different service networks with the same template, you can assign different numbers to each port. However, using variables is not a guarantee that the port numbers will be different. You must still avoid assigning the variables the same value. For more information, see "Variables" section.

Sharing Devices and Global Network Policies

It can be problematic for two or more service networks to share a device and have global network policies with the same name. For example, you start Service Network A, and a configuration macro runs the probe myPING icmp command on a CSM device. You then start Service Network B, and one of its configuration macros runs the same command using the same name.

Both service networks function properly at this point. However, when you stop either of the two service networks, the unconfiguration macros remove the global network policy from the CSM device. This action causes a failure on the service network that is left running. To avoid this problem, make sure to assign unique names to global network policies.

Handling Responses to CLI Commands

By default, commands, such as those in the config() subroutine, fail when the response from the device contains anything other than the device CLI prompt.

For example, a device CLI prompt is "prompt#", and the configuration macro runs the following subroutine:
config(" 
interface vlan230
nameif outside 
");
The following is a successful response:
prompt#
The following is a failed response:
"INFO: Security level for \".*\" set to .* by default."
prompt#
In this case, the config() subroutine detects the "INFO: Security level for \".*\" set to .* by default" message between the config() command and the "prompt#", and the macro exits with an error.

However, if the message was expected and is not an error, then you can permit it (and a list of other messages) to appear between the subroutine and the prompt. For example:
@exceptions = ("INFO: Security level for \".*\" set to .* by 
default.");
set_config_check(@exceptions);
config(" 
interface vlan230
nameif outside 
");
In this case, the config() subroutine runs successfully even if the "INFO: Security level for \".*\" set to .* by default." message appears.

You can also enter the following command so that VFrame ignores any message between the command and the prompt:
@exceptions = (".*");
set_config_check(@exceptions);
To reset the exception list so that VFrame reports a failure on any error, enter the following command:
@exceptions = ("");
set_config_check(@exceptions);
Auto-Correcting Macros

You can create macros that are linked to verification operations (Verify Network, Verify Server, and Verify Server Group events). In this way, when you verify your service network, any discrepancies are reported, and if auto-correction is enabled (and functioning), they are also corrected. For auto-correction to function, your verification macros must contain the same commands that are in your configuration macros. Macros that have auto-correction enabled are displayed with a green check mark.

For information about verifying your service networks, see Verifying Service Networks.

Macro Assignment

You can link macros to many types of events and targets. In addition, for a single target, you can assign the same macro to different events. For more information, see Events, and Targets.

Macro Management

You manage macros from within templates. Macros you create within templates can be used only within the template for which it was created. However, at any time, you can export macros created within templates and then reimport them into other templates.

For information about creating macros within templates, see Working with Macros.

Variables

Variables are representations of values to be used in macros within VFrame. Multivalue variables are variables that contain more than one value and can be primitive types or resource types. When multivalue variables are resource types, they must be assigned resource pools.

When you designate a variable as multivalued and assign a resource pool to it, VFrame creates an array to hold the variable values. In most cases, you decide how many values should be in the multivalued variable. In other cases, VFrame assigns the number of values. However, even when VFrame assigns the number of values, the number is based on information you provided in your service network template. For example, when creating a server group, VFrame creates a value for every logical server you create. Because you create the server, you decide how many values are in the value group. When a macro refers to a multivalue variable, the macro is run on each value supplied.

You can define variables within macros as you create templates. For added flexibility, you can define variable group types in the global library. By using the global library, you create variable groups types that you can use repeatedly to create common variable groups.

Variable groups that you create from within templates can be used only within the template for which they were created. However, by using the global library, you can create variable group types, which can be shared among all templates throughout VFrame.

After a template has been saved, you can export macros created within the template and then reimport them into other templates. However, when you export a macro that references a variable group type in the global library, only the reference to the variable group type, not the variable group type itself, is exported. Therefore, you must make sure that the global variable group type exists on the VFrame into which you are importing the macro.

For information about creating variables within templates, see Working with Variables. For more information about creating variable and variable group types, see Working with Variable and Variable Group Types.

Aliases

Aliases are used in service network and storage templates to link variable or variable group values. You can assign a value to one variable or variable group and the same value is automatically assigned to the linked variable or variable group. LOM manager templates do not need to link variable or variable group values; therefore, the aliasing feature is not used.

When you define an alias, you set one of the variables or variable groups as the primary. Then, when defining values for variables, all aliased variables are shown. You enter or change the value for the primary variable, and the value is then propagated to all other variables or variable groups within the alias.

For details about creating, editing, and deleting variable and variable group aliases, see Working with Aliases.

Working with Basic Template Components

Whether you are creating a service, storage, or LOM template, all templates are made up of many of the same components.

The following topics help you work with the common components required for creating all types templates:

•Changing Targets

•Working with Events

•Working with Macros

•Working with Variables

•Creating and Editing Aliases

For specific steps to create and manage each type of template, see the following topics:

•Working with Service Network Templates

•Working with Storage Manager Templates and Storage Managers

•Working with LOM Manager Templates

Changing Targets

Targets are the physical resources acquired when a service network is deployed.

When you create a storage or LOM template, the target is defined as part of the process of creating the template.

For service network templates, several different targets exist, depending on the types of logical elements and endpoints that you have defined in your template. In this case, when you drag and drop a logical element into your template, you are prompted to define the target type value if more than one target type exists for that logical element. Later, if you decide to change the target value, you can do so using this procedure.

Procedure

Step 1 Select Design > Templates.

Step 2 From the Templates tab, create a new template or open an existing template.

Step 3 Select the desired logical element.

Step 4 Click the Supported Targets tab.

Step 5 From the Supported Targets tab, right-click a constraint, select Change Constraint Value and select the constraint value.

Step 6 Click Save.

Related Topics

•Targets

•Supported Targets Tab

Working with Events

You can create, edit, and delete events when working with service network templates. This type of management of events is not required for storage templates or LOM Manager templates because the events required by these templates are provided by VFrame.

The following topics help you work with events:

•Creating, Editing, and Viewing Events

•Deleting Events

Creating, Editing, and Viewing Events

You can create events for logical elements in your service network template. You can also edit or view any type of event. However, you cannot create network events.

Procedure

Step 1 Select Design > Templates.

Step 2 From the Template Design tab, create a new template or open an existing template.

Step 3 Click the Events tab.

Step 4 From the Events tab, do one of the following:

•To create an event, right-click the desired logical element folder and select Add event.

•To edit or view an event, right-click the desired event and select Edit/View.

Step 5 From the Event dialog box, enter or modify the field values as appropriate. For details, see Event Dialog Box.

Step 6 After creating an event, you need to assign a macro to it. See Creating Macro Assignments.

Tips

You can also access the Event dialog box from the Macro Map tab. To add an event, right-click the map area and select Add event. To edit or delete an event, right-click the desired event and select Edit event or Delete event.

Related Topics

•Events

•Events Tab

Deleting Events

You can delete only user-created events that have not been assigned a macro. You cannot delete default system events (shown in bold).

Procedure

Step 1 Select Design > Templates.

Step 2 From the Templates tab, create a new template or open an existing template.

Step 3 Click the Events tab.

Step 4 Right-click the desired event and select Delete.

Step 5 Click Save.

Related Topics

•Events

•Events Tab

Ordering Events

For service network templates, you can change the order that events and macros are executed.

Procedure

Step 1 Select Design > Templates.

Step 2 From the Templates tab, create a new template or open an existing template.

Step 3 Click the Events tab.

Step 4 Right-click the desired event and select Change Ordering. The Event Ordering dialog box opens.

Step 5 Select the desired event or macro and click the up or down arrow buttons to move the event or macro.

Note You cannot change the order of system actions or move events and macros before system actions.

Step 6 Click Save.

Tips

You can also access the Event Ordering dialog box from the Macro Map tab. From the Macro Map Tab, right-click the desired event and select Change Ordering.

Related Topics

•Events

•Events Tab

Working with Macros

These topics help you perform tasks related to macro file containers:

•Creating, Editing, and Viewing Macro File Containers

•Exporting Macro File Containers

•Exporting Macro File Containers

•Deleting Macro File Containers

These topics help you perform tasks related to macros:

•Creating, Editing, and Viewing Macros

•Deleting Macros

•Creating Macro Assignments

•Deleting Macro Assignments

•Ordering Macro Execution

Creating, Editing, and Viewing Macro File Containers

Before you can create macros, you need to create a macro file container. If needed, you can also edit and view macro file containers.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 From the Templates tab, Storage Managers tab, or LOM Managers tab, create a new template or open an existing template.

Step 3 Click the Macro Assignments tab.

Step 4 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Note In service network templates, the Macros tab only appears for logical elements that support macros.

Step 5 Do one of the following:

•To create a macro file container, click Create Container, and enter the name, description, and author of the macro file container in the appropriate fields.

•To edit or view a macro file container, select the macro file container, click the Edit button, and change the name, description, and author of the macro file container, as desired.

Note You can only edit macro file containers in storage and LOM manager templates for which you have not created a storage or LOM manager.

Step 6 Click OK.

Tips

For service network templates, you can also access the Macros tab from the Properties tab. From the Properties Tab, click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Related Topics

•Macros

•Macros Tab

Importing Macro File Containers

You can import macro file containers that you created outside VFrame or on another VFrame server.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Click the Import macro container button.

Step 5 Navigate to the directory in which the desired macro file container is located, select the macro file container, and click Open.

Tips

•For service network templates, you can also access the Macros tab from the Properties tab. From the Properties Tab, click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

•You can also import macro file containers from the Edit Macro assignment dialog box. From the Macro Assignments Tab, click the Associate macro button and then click the Import macro container button.

For service network templates only, you can also access the Macro Assignment tab from the Macro Map tab. From the Macro Map Tab, right-click an event, and select Associate macro.

Related Topics

•Macros

•Macros Tab

Exporting Macro File Containers

You can export macro file containers that you created in VFrame.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Select the desired macro file container and click the Export macro container button.

Step 5 Navigate to the directory in which you want to place the macro file container, name it, and click Save.

Related Topics

•Macros

•Macros Tab

Deleting Macro File Containers

You can delete macros that you no longer need.

Before You Begin

Make sure that the macro file container does not have macros that were assigned to targets. Macros that were assigned targets are considered to be in use and cannot be deleted.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Select the desired macro file container and click the Delete button.

Step 5 Click Save.

Tips

For service network templates, you can also access the Macros tab from the Properties tab. From the Properties Tab, click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Related Topics

•Macros

•Macros Tab

Creating, Editing, and Viewing Macros

You can create macros to use within templates.

Before You Begin

•Create a macro file container. See Creating, Editing, and Viewing Macro File Containers.

•Understand the design principles involved in creating macros. See Macros.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Do one of the following:

•To create a new macro, select the desired macro file container and click the New Macro button.

•To edit or view an existing macro, select the desired macro and click the Edit button.

The Edit Macro dialog box appears.

Step 5 Enter or change information in the fields, as necessary. For details, see Edit Macro Dialog Box.

Step 6 If needed, create variable groups and variables. For details, see Working with Variables.

Step 7 Click OK.

Step 8 Click Save.

Tips

For service network templates, you can also access the Edit Macro dialog box from the Macro Map tab. From the Macro Map Tab, right-click the desired macro and select Edit/View macros or right-click the desired event, select Associate macro, and click the New Macro or Edit button.

Related Topics

•Macros

•Edit Macro Dialog Box

•Variables

Deleting Macros

You can delete macros, if they are no longer used.

Before You Begin

Make sure that the macro has not been assigned to targets. Macros that were assigned targets are considered to be in use and cannot be deleted.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Select the desired macro and click the Delete button.

Step 5 Click OK.

Step 6 Click Save.

Tips

For service network templates, you can also access the Macros tab from the Properties tab. From the Properties Tab, click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Related Topics

•Macros

•Macros Tab

Creating Macro Assignments

In order for a macro to be executed on a particular target, you need to associate the macro to the target. You can also define the order in which macros are run when the associated event occurs.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click the Associate macro button. The Macro Assignments dialog box opens.

Step 4 Select the target and event to which you want to assign the macro.

Step 5 Select one of the available macros. Alternatively, you can import a new macro file container or create a new macro, and then select the macro.

Step 6 Click OK.

Step 7 Click Save.

Tips

For service network templates, you can also access the Macro Assignments dialog box from the Macro Map tab. From the Macro Map Tab, right-click the desired event and select Associate macro.

Related Topics

•Macros

•Edit Macro Assignment Dialog Box

Deleting Macro Assignments

If you no longer want a macro associated with a target, you can disassociate it.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Select the macro assignment you want to delete and click the Delete button.

Tips

For service network templates, you can also access the Macro Assignments dialog box from the Macro Map tab. From the Macro Map Tab, right-click the desired event and select Associate macro.

Related Topics

•Macros

•Macro Assignments Tab

Ordering Macro Execution

For service network templates, you can change the order in which macros are run.

Note Some system-defined events have system actions associated with them. These system actions have predetermined ordering that cannot be changed. However, you can change the order of macros that you create.

Procedure

Step 1 Select Design > Templates.

Step 2 From the Templates tab, create a new template or open an existing template.

Step 3 Click the Macro Maps tab.

Step 4 Right-click the desired event and select Change ordering. The Event Ordering dialog box opens.

Step 5 Select the desired macro and click the up or down arrow buttons to move the macro.

Step 6 Click Save.

Tips

You can also access the Event Ordering dialog box from the Events tab. From the Events Tab, right-click the desired event and select Change Ordering.

Related Topics

•Macros

•Event Dialog Box

Working with Variables

The following topics help you work with variables while creating or modifying templates.

•Creating, Editing, and Deleting Variable Groups

•Creating, Editing, and Deleting Variables

Creating, Editing, and Deleting Variable Groups

You can group related variables by creating variable groups. In addition, you can edit and delete variable groups, if needed.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Click the Variables tab.

Step 5 Navigate to the macro file container where you want to create, edit, or delete variables.

Step 6 Do one of the following:

•To create a variable group, right-click on the desired macro file container and select Create Variable Group. Enter information in the fields and click OK. For details, see Variable Group Dialog Box.

•To edit a variable group, right-click on the desired variable group and select Edit Variable Group. Enter or change the values in the fields and click OK. For details, see Variable Group Dialog Box.

•To delete a variable group, right-click on the desired variable group and select Delete Variable Group. The variable group is deleted.

Step 7 Click OK.

Tips

For service network templates, you can also access the Variables tab from the Properties tab. From the Properties Tab, click Macros & Variables and then click the Variables tab.

Related Topics

•Variables

•Variables Tab

•Variable Group Dialog Box

Creating, Editing, and Deleting Variables

You can create, edit, and delete variables while creating or modifying templates.

Note You can edit and delete only user-defined variables. System-defined variables cannot be changed or deleted.

Before You Begin

Create a variable group to contain your variables, if necessary. For details, see Creating, Editing, and Deleting Variable Groups.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Click the Variables tab.

Step 5 Navigate to the macro file container where you want to create, edit, or delete variables.

Step 6 Do one of the following:

•To create a variable, right-click on the desired variable group and select Create Variable. Enter information in the fields and click OK. For details, see Variable Dialog Box.

•To edit a variable, right-click on the desired variable and select Edit Variable. Enter or change the values in the fields and click OK. For details, see Variable Dialog Box.

•To delete a variable, right-click on the desired variable and select Delete Variable. The variable group is deleted.

Step 7 Click OK.

Tips

For service network templates, you can also access the Variables tab from the Properties tab. From the Properties Tab, click Macros & Variables and then click the Variables tab.

Related Topics

•Variables

•Variables Tab

•Variable Dialog Box

Working with Aliases

The following topics help you work with aliases:

•Creating and Editing Aliases

•Deleting Aliases

Creating and Editing Aliases

Aliases are used in service network and storage templates to link variable or variable group values. You can assign a value to one variable or variable group and the same value is automatically assigned to the linked variable or variable group. LOM manager templates do not need to link variable or variable group values; therefore, the aliasing feature is not used.

You can define aliases for variables and variable groups. An alias must contain at least two variables or variable groups. When you define an alias, you set one of the variables or variable groups as the primary. Then, when defining values for variables, all aliased variables are shown. You enter or change the value for the primary variable, and the value is then propagated to all other variables or variable groups within the alias.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Click the Aliases tab.

Step 5 Do one of the following:

•To create a new variable or variable group alias, click New and select New alias for variables or New alias for variable groups, as appropriate.

•To edit an existing variable or variable group alias, select the alias from the left pane and click the Edit button.

Step 6 Enter a name and description in the appropriate fields.

Step 7 Do one of the following:

•To add variables to a variable alias, select the desired variable from the Variables field and click Add. Repeat for each variable you want to add to the alias.

•To add variable groups to a variable group alias, select the desired variable group from the Typed Variable Groups field and click Add. Repeat for each variable group that you want to add to the alias.

Note You cannot mix variables and variable groups in a single alias.

Step 8 Select one of the variables or variable groups to set as the primary variable for the alias and click Set Primary Variable. Setting a variable as the primary variable means that the value entered for the primary variable is used for all other variables that are aliased to the primary variable.

Step 9 Click OK.

Tips

For service network templates, you can also access the Aliases tab from the Properties tab. From the Properties Tab, click Macros & Variables and then click the Aliases tab.

Related Topics

•Aliases

•Aliases Tab

•Alias Dialog Box

Deleting Aliases

When a variable or variable group alias is no longer needed, you can delete it.

Procedure

Step 1 Select Design > Templates, Storage Managers, or LOM Managers.

Step 2 Do one of the following:

•From the Templates tab, create a new template or open an existing template, and then select a logical element.

•From the Storage Managers tab or LOM Managers tab, create a new template or open an existing template.

The Macro Assignments tab opens.

Step 3 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 4 Click the Aliases tab.

Step 5 Select the variable or variable group alias from the left pane and click Delete.

Step 6 Click Yes to confirm the deletion.

Tips

For service network templates, you can also access the Aliases tab from the Properties tab. From the Properties Tab, click Macros & Variables and then click the Aliases tab.

Related Topics

•Aliases

•Aliases Tab

•Alias Dialog Box

Service Templates

The following topics provide detailed information about service network templates:

•Creating Service Network Templates—Basic Workflow

•Understanding Service Network Templates

•Creating a Service Network Template—Scenario

•Working with Service Network Templates

•Troubleshooting Service Network Template Design

•Templates Tab

Creating Service Network Templates—Basic Workflow

Table 11-2 is an overview of the steps you take to create a service network template in VFrame.

Table 11-2 Creating Service Network Templates—Basic Workflow

Task

Step 1

Create a service network template (see Creating and Modifying Service Network Templates). As part of this task and depending on your service network template design, do the following, as required:

•Create variables and variable groups (see Creating, Editing, and Deleting Variable Groups).

•Create variable aliases (see Creating and Editing Aliases).

•Create macros (see Creating, Editing, and Viewing Macros).

•Assign macros to events and targets (see Creating Macro Assignments).

Step 2

Validate your service network template (see Validating Service Network Templates).

Step 3

Save and publish your service network template (see Saving and Publishing Service Network Templates).

Understanding Service Network Templates

In a data center, you might need to create several service networks, all with the same basic topology and with a few differences. This task typically requires that you create each service network individually, repeating the same steps and commands for each. VFrame simplifies this task by allowing you to create a service network template to define these common topologies. You then use the service network template to define several service networks. Using variables, you fill in the unique values required for the devices in each specific service network.

Service network templates are made up of logical elements (such as Firewall Services Modules, switches, load balancers, and server groups) and endpoints (links).

You create service network templates by creating a network map that includes the elements required for your service. You then define basic information about your template and the elements within it. This basic information, along with other information supplied later when you create and start your service network, is used to acquire and manage the elements in your service network.

In order to define service network templates, you must understand the basic components that make up templates in general. See Understanding Basic Template Components.

In addition to the basic components, service network templates have these additional components:

•Service Network Template Elements

•Service Network Template Design and Network Virtualization

•Service Network Template States

•Service Network Template Change Control

Service Network Template Elements

In service network templates, elements are logical representations of devices and links within your service network. Devices are referred to as logical elements, and the ports at the ends of the links are referred to as endpoints. You can design various service network templates using logical elements and endpoints.

When you include a logical element or endpoint in your service network template, system actions and default variables are also included. These system actions perform functions that are required for basic operation of your network. For more information, see "System Actions, Default Variables, and Resource Attribute Variables."

You can also create user macros and assign them to the logical elements and endpoints. Table 11-3 describes these logical elements and endpoints.

Table 11-3 Service Network Logical Elements and Endpoints

Element

Description

Firewall

Represents one FWSM virtual context.

ExternNet

Represents one or more tracking interfaces that were determined at the time a particular physical Layer 3 switch was managed.

Layer 2 switch

Represents a VLAN, which could reside on multiple switches.

You cannot assign user macros to Layer 2 switch logical elements. However, you can assign user macros to Layer 2 switch endpoints linked to server groups. You can alias the SwitchServerPropertyGroup variable group to user macros assigned to Layer 2 endpoints.

Layer 3 switch

Represents one Layer 3 switch. Each L3 switch endpoint represents an SVI.

Load balancer

Represents a Content Switch Module (CSM).

Server group

Represents one or more servers.

Firewall HA

Represents a pair of FWSM virtual contexts in different FWSMs that are part of the same redundant pair of FWSMs.

Layer 3 switch HA

Represents two Layer 3 switches. Each Layer 3 switch HA endpoint represents an SVI or an SVI configured in the same HSRP group, depending on the value chosen when the link is created.

Load balancer HA

Represents a pair of CSMs configured for redundancy.

End points (Links)

Represents interfaces on the device. Interfaces on a Layer 2 switch connected to a server group represent an IOS Ethernet or EtherChannel switch port, depending on the value chosen when the link is created.

Service Network Template Design and Network Virtualization

Virtualization allows you to share resources. An action performed on a shared resource might affect another service network that shares the resource. In addition, some resources can only be acquired once. These situations can affect the way you design your service network template. Two examples follow that represent CSM service network templates.

Example 1

It is not practical to design a service network template with too many logical servers connected to a load balancer. Instead, you should partition these logical servers into several different service network templates.

In this example, you have three server groups with corresponding server farms. Because there are several server groups under one client VLAN, you can create a CSM service network template, as the one shown in Figure 11-7.

Figure 11-7 CSM Service Network Template—Case 1

In this case, the template includes a load balancer logical element with a client/sever VLAN and three server groups with corresponding server farms and logical servers. Using this template, you are able to create a switch virtual interface (SVI) and a client/server VLAN. In this case, you must deploy all CSM services in one service network.

However, if there are large numbers of logical servers in one client VLAN, it is not practical to deploy all logical servers under one load balancer logical element. Instead, you could partition the configuration into multiple networks. Keeping in mind that any VLAN created by VFrame for a Layer 3 switch cannot be shared, you cannot deploy multiple CSM service networks under one client/server VLAN when using a Layer 3 switch. In this case, you must configure the SVI and the client/server VLAN directly on the device. Figure 11-8 shows the CSM service network template for this case.

Figure 11-8 CSM Service Network Template—Case 2

In this case, each load balancer logical element includes two logical servers with corresponding server groups (server farms). Because the client/server VLANs are preconfigured instead of being configured through the template, you can reuse this template to deploy more CSM service networks under one client/server VLAN.

Example 2

In VFrame, the gateway and the VLAN can only be acquired once. To deploy multiple service networks based on this configuration, you need to create and deploy the service network template shown in Figure 11-9 to configure SVI, the client VLAN, and the server VLAN. (Alternatively, you can manually configure the SVI, client VLAN, and server VLAN.)

Figure 11-9 CSM Service Network Template—VLAN and SVI Configuration

Create and deploy another service network template (shown in Figure 11-10) that performs the remainder of the required configuration, but does not configure the client VLAN 100 and server VLAN 200.

Figure 11-10 CSM Service Network Template—No VLAN Configuration

Service Network Template States

As you work through the process of designing and using service network templates, the template changes from one state to another and is noted in parenthesis next to the template name in the Service Templates selector on the Templates tab.

Table 11-4 lists and describes all of the possible states.

Table 11-4 Template States

State

Description

Designing

Template is being created or modified and has not yet been verified. Does not indicate whether the template has been saved.

Verified

Template was validated. Does not indicate whether the template has been saved or not.

Published

Template was validated, saved, and is ready to be used to design a service network. Only templates that are in the published state can be used to design service networks.

In Use

Template is published and a service network was created using the template.

IncrementalDesigning

A service network was created using the template, but the template is now being modified. For details, see Understanding Service Network Templates.

IncrementalVerified

A service network was created using the template, and the template was modified and verified. For details, see Understanding Service Network Templates.

ViewOnly

A service network was created using the template, and the template is open for viewing. Changes are not permitted.

Service Network Template Change Control

Before you create a service network based on a service network template, you can make changes to the template.

After you create a service network based on a service network template, certain restrictions apply to the changes that you can make to the template. You can make changes while the service network is running; however, you are asked whether you want to modify an incremental version of the template or display the template in view-only mode. If you choose to modify an incremental version, the template state changes to IncrementalDesigning.

These are the changes that you are allowed to make:

•You can add new variables or variable groups as long as the variables and variable groups are aliased.

•You can delete variable or variable groups as long as the variable or variable group was previously aliased.

•You can delete variables or variable groups that were added while the template was in the IncrementalDesigning state.

•You can create or import new macros and modify existing macros.

•You can add events to logical elements, associate macros to events, or change the order of events.

•You can delete macros that were added while the template as in the IncrementalDesigning state.

These are the changes that you are not allowed to make:

•You cannot create additional service networks based on service network templates in the IncrementalDesigning state.

•You cannot delete variables or variable groups that are not aliased.

•You cannot remove variables or variable group types from an alias.

•You cannot delete or disassociate macros.

•You cannot delete events.

•You cannot alias pre-existing variables.

After you finish making changes, you must save the service network template. Saving the template automatically validates it. If no errors are encountered during the validation, you can publish your template. If errors are encountered, you can still save your template, but you cannot publish it. You need to validate the template by clicking the Validate button and correct any errors first. After you save the changes, the service network template state changes to In Use. For more information about template states, see Creating a Service Network Template—Scenario.

Note You cannot save changes to a service network template while the service network is acting on an event. As soon as the event is done, you can save the changes.

Creating a Service Network Template—Scenario

In this scenario, the service network template you create is based on a sample network design in which you have a switch with a CSM connected in single subnet (bridge) mode to a group of servers, as shown in Figure 11-11.

The template must provide the necessary configuration information about the switches, CSM, and servers so that when you deploy a service network based on this template, VFrame configures the physical devices appropriately.

Because VFrame automatically configures access ports, VLANs, and server IP addresses on Ethernet interfaces, you do not need to create macros to configure these. However, you must create macros for VFrame to configure the additional features required in your network, in this case, the features required for CSM.

You can use a template to create several service networks that are based on the same network topology. For example, you might use this template for another service network in which you have CSM but the devices have different IP addresses (see Figure 11-12). You do this by using variables and variable groups in macros.

This scenario shows you how to:

•Create a Template

•Mock Up CLI

•Identify Variables and Variable Groups

•Create Variables and Variable Groups

•Create Variable Aliases

•Create Macros

•Assign Macros to Events and Targets

•Validate Your Service Network Template

•Save and Publish Your Service Network Template

Tip You can use this scenario as a model to create other templates for different network designs.

Figure 11-11 Sample Service Network Topology

Figure 11-12 Similar Service Network Topology

Create a Template

Create a template with the basic elements in your network design. In this scenario, the sample network design contains a Layer 3 switch, Layer 2 switch, a group of servers, and a load balancer connected in single subnet (bridge) mode (see Figure 11-11).

Procedure

Step 1 Select Design > Templates to open the Template Design tab.

Step 2 Click New. The Input dialog box appears.

Step 3 Enter the template name in the Template Name field. For this scenario, enter CSM-Template as the name.

The template name appears in the selection tree on the Elements tab, and a tab with the template name appears above the template topology work area.

Step 4 Drag and drop the following logical element icons into the template topology work area:

•Layer 3 switch

•Load balancer (When prompted to choose the type, select Content Switching Module Router Mode and click OK.)

•Layer 2 switch

•Server group

When you include logical elements in your template, system actions and default variables are automatically included as well. You will notice these macros attached to events on the Macro Map tab. The default variables will appear when you design your service network later in "Designing Service Networks." For a complete list of system actions and default variables by logical element, see "System Actions, Default Variables, and Resource Attribute Variables."

Step 5 Connect the Layer 3 switch and the load balancer. To do this, click the Connect button, click the load balancer, and then click the Layer 2 switch.

Step 6 Connect the load balancer and the Layer 2 switch. To do this, click the Connect button, click the load balancer, and then click the Layer 2 switch.

Step 7 Connect the layer 2 switch and the server group. To do this, click the Connect button, click the layer 2 switch, and then click the server group. When prompted to choose the link type, select IOS Switch Ethernet Port and click OK.

Your template, shown in Figure 11-13, now looks similar to the network diagram shown in Figure 11-11.

Figure 11-13 CSM-Template

Mock Up CLI

Before beginning, it is a good idea to note which features you must configure and mock up the CLI that you will use. The CLI will be used in your macro, and from this, you can also identify the values for which you will have to create variables and variable groups.

For example:

1. Configure the CSM (This is done automatically by VFrame. You do not need to create a macro to do this.):
cat(config)#module csm 3 
cat(config-module-csm)#
2. Create the client-side VLAN and gateway:
cat(config-module-csm)#vlan 100 client 
cat(config-slb-vlan-client)#ip address 10.11.100.2 255.255.255.192 
cat(config-slb-vlan-client)#gateway 10.11.100.1 
cat(config-slb-vlan-client)#
3. Create the server-side VLAN:
cat(config-module-csm)#vlan 200 server 
cat(config-slb-vlan-server)#ip address 10.11.100.2 255.255.255.192
4. Create the server farm:
cat(config-module-csm)#serverfarm wwwfarm
cat(config-slb-sfarm)#real 10.11.100.4 
cat(config-slb-real)#inservice 
cat(config-slb-real)#real 10.11.100.5 
cat(config-slb-real)#inservice
5. Create Vserver and associate server farm:
cat(config-module-csm)#vserver VS1 
cat(config-slb-vserver)#virtual 10.11.100.241 any
cat(config-slb-vserver)#serverfarm SF1
cat(config-slb-vserver)#inservice
Identify Variables and Variable Groups

In order to use the template to configure CSM on other service networks with different IP addresses and other values, you must create variables and variable groups for any specific values used to configure CSM.

The CLI commands are repeated here, this time substituting variables for specific values:

Note Variables are designated by a preceding "$". For variables that are part of a variable group, the group name is first, followed by the variable name in brackets.

1. Configure the CSM (This is done automatically by VFrame. You do not need to create a macro to do this.):
cat(config)#module csm 3 
cat(config-module-csm)#
2. Create the client-side VLAN and gateway:
cat(config-module-csm)#vlan $ClientVlanID $ClientVlanType
cat(config-slb-vlan-client)#ip address $ClientVlanIP->{IPAddress}
cat(config-slb-vlan-client)#gateway $ClientVlanGtw->{IPAddress}
3. Create the server-side VLAN:
cat(config-module-csm)#vlan $ServerVlanID $ServerVlanType
cat(config-slb-vlan-server)#ip address $ServerVlanIP->{IPAddress}
4. Create the server farm:
cat(config-module-csm)#serverfarm $ServerFarmName
cat(config-slb-sfarm)#real $RealServerIP->{IPAddress}
cat(config-slb-real)#inservice 
5. Create Vserver and associate server farm:
cat(config-module-csm)#vserver $VServerName
cat(config-slb-vserver)#virtual $VServerIP->{IPAddress} any
cat(config-slb-vserver)#serverfarm $VServerName
cat(config-slb-vserver)#inservice
A compiled list of these variables is listed in Table 11-5. Note that related variables are grouped.

Table 11-5 Variables and Variable Groups in the CSM T66emplate

Name

Type

Description

ClientVlanIP

IPAddressGroupType

Client VLAN IP address and netmask.

IPAddress

IPAddrResourceType

IP address of client VLAN.

ClientVlanGtw

IPAddressGroupType

Client VLAN gateway IP address and netmask.

IPAddress

IPAddrResourceType

IP address of client VLAN gateway.

ServerVlanIP

IPAddressGroupType

Server VLAN IP address and netmask.

IPAddress

IPAddrResourceType

IP address of server VLAN.

RealServerIP

IPAddressGroupType

Real server IP address and netmask.

IPAddress

IPAddrResourceType

IP address of real server.

VServerIP

IPAddressGroupType

CSM logical server IP address and netmask.

IPAddress

IPAddrResourceType

IP address of CSM logical server.

CSM_container_dflt_grp

Default variable group.

Default variable group.

ClientVlanID

Vlan

CSM client VLAN ID.

ServerVlanID

Vlan

CSM server VLAN ID.

ClientVlanType

String

Client VLAN type.

ServerVlanType

String

Server VLAN type.

VserverName

String

CSM logical server name.

ServerFarmName

String

CSM server farm name.

Create Variables and Variable Groups

Now that you have identified all of the variables you need, you can create them in VFrame. First, you create a macro file container in which to add the variables and variable groups. Then, you create the variables and variable groups.

The variables you create are local to the macro and logical element for which they will be used. In other words, you create variables that will be used in macros that act on a particular logical element.

For most of the variables groups in this scenario, system variable group types are available for you to use. System variable group types are predefined variable groups provided by VFrame that you can use over and over again. In addition to system variable group types, VFrame provides you with the capability to create your own user-defined variable group types. For more information about variable group types, see Understanding Variable and Variable Group Types.

Procedure

Step 1 Select Design > Templates to open the Template Design tab.

Step 2 Open the template you just created, if it is not already open.

Step 3 Select the logical element for which you want to create variables. For this scenario, select the load balancer logical element from the template map area.

Step 4 Create a macro file container to contain all of the variable groups and variables that you will need:

a. Click the Macro Assignments tab.

b. Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Note In service network templates, the Macros tab only appears for logical elements that support macros.

c. Click Create Container, and enter the name, description, and author of the macro file container in the appropriate fields. For this scenario, enter CSM as the name, Bridge mode CSM macro container as the description, and your name as the author.

d. Click OK.

Step 5 Create variable groups:

a. Click the Variables tab.

a. Right-click the macro file container you just created and select Create Variable Group. The Variable Group dialog box opens.

b. Enter the following information in the fields:

–Name—Enter a name for the variable group. For example, enter ClientVlanIP as the name.

–Use Group Type—Select the Use Group Type check box. The Variable Group Type Selector dialog box opens. Navigate to and select the variable group type named IPAddressGroupType, and then click OK.

For detailed information about all of the fields in this dialog box, see Variable Group Dialog Box. For more information about variable group types in general, see Understanding Variable and Variable Group Types.

c. Repeat these steps for all variable groups you need to create. For example, you would repeat these steps to create the ClientVlanGtw and ServerVlanIP variable groups. Figure 11-14 shows the Variables tab listing the new variable groups.

d. Click OK.

Step 6 Click Save to save your work.

Figure 11-14 CSM-Template Variables

Create Variable Aliases

Aliases allow you to link variable values. In this way, you can assign a value to one variable and the same value is automatically assigned to the linked variable.

When you define an alias, you set one of the variables or variable groups as the primary. Then, when defining values for variables, all aliased variables are shown. You enter or change the value for the primary variable, and the value is then propagated to all other variables or variable groups within the alias.

In this scenario, the variables listed in Table 11-6 use the same values, so you can create aliases for them.

Table 11-6 Variable Aliases for the CSM Template

Alias Name

Variable

Description

CSMClientServerIPAddr

LoadBalancer > To_Layer2Switch > IPAddressGroup > IPAddress

IP address of load balancer port connected to Layer 2 switch.

LoadBalancer > To_Layer3Switch > IPAddressGroup > IPAddress

IP address of load balancer port connected to Layer 3 switch.

LoadBalancer > CSM > ClientVlanIP > IPAddress

(Variable set as primary.)

IP address of the client VLAN on the load balancer.

LoadBalancer > CSM > ServerVlanIP > IPAddress

IP address of the server VLAN on the load balancer.

CSMClientVlanType

LoadBalancer > To_Layer3Switch > LBInterfaceVariableGroup > InterfaceType

Type of interface on the load balancer that is connected to the Layer 3 switch.

LoadBalancer > CSM > CSM_container_dflt_grp > ClientVlanType

(Variable set as primary.)

Type of client VLAN on the load balancer.

CSMServerVlanType

LoadBalancer > To_Layer2Switch > LBInterfaceVariableGroup > InterfaceType

Type of interface on the load balancer that is connected to the Layer 2 switch.

LoadBalancer > CSM > CSM_container_dflt_grp > ServerVlanType

(Variable set as primary.)

Type of server VLAN on the load balancer.

Layer2VlanID

Layer2Switch > VlanGroup > Vlan

VLAN on the Layer 2 switch.

LoadBalancer > To_Layer2Switch > LBInterfaceVariableGroup > Vlan

VLAN on the load balancer interface to the Layer 2 switch.

LoadBalancer > CSM > CSM_container_dflt_grp > ServerVlanID

(Variable set as primary.)

VLAN on the load balancer.

L3SVIIPAddress

ServerGroup > DefaultGateway > GatewayIPAddress

IP address of the default gateway on the server group.

Layer3Switch > To_LoadBalancer > SviIpAddressGroup > IPAddress

SVI IP address on the Layer 3 switch interface connected to the load balancer.

LoadBalancer > CSM > ClientVlanGtw > IPAddress

IP address of the client VLAN gateway on the load balancer.

L3SviVlanID

Layer3Switch > To_LoadBalancer > SviVlanGroup > Vlan

SVI VLAN on the Layer 3 switch interface connected to the load balancer.

LoadBalancer > To_Layer3Switch > LBInterfaceVariableGroup > Vlan

VLAN on the load balancer interface connected to the Layer 3 switch.

LoadBalancer > CSM > CSM_container_dflt_grp > ClientVlanID

(Variable set as primary.)

VLAN on the load balancer.

ServerGroupIPaddress

ServerGroup > To_Layer2Switch > IPAddressGroup > IPAddress

IP address of the server group interface that is connected to the Layer 2 switch.

LoadBalancer > CSM > RealServerIP > IPAddress

(Variable set as primary.)

Real server IP address of the load balancer interface.

Procedure

Step 1 Select Design > Templates to open the Template Design tab.

Step 2 Open the template you just created, if it is not already open.

Step 3 Select the logical element for which you want to create variable aliases. For this scenario, select the load balancer logical element from the template map area.

Step 4 Click the Macro Assignments tab.

Step 5 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 6 Click the Aliases tab.

Step 7 Create variable aliases:

a. Click New and select New alias for variables. The Alias dialog box opens.

b. Enter the following information in the fields:

–Name—Enter a name for the variable alias. For example, enter CSMClientServerIPAddr as the name.

–Description—Enter a description for the variable alias. For example, enter Load balancer IP addresses.

c. From the Variables box, add each of the variables to the variable alias:

–Open LoadBalancer > To_Layer2Switch > IPAddressGroup, select the IPAddress variable, and click Add.

–Open LoadBalancer > To_Layer3Switch > IPAddressGroup, select the IPAddress variable, and click Add.

–Open LoadBalancer > CSM > ClientVlanIP, select the IPAddress variable, and click Add.

–Open LoadBalancer > CSM > ServerVlanIP, select the IPAddress variable, and click Add.

d. From the Alias Contents box, select the LoadBalancer > CSM > ClientVlanIP variable and click Set Primary Variable.

Step 8 Repeat Step 7 for each of the variable aliases you need to create. See Table 11-6 for a list of variable aliases required for the CSM template. Figure 11-15 shows the Aliases tab listing the new variable aliases.

Figure 11-15 CSM-Template Variable Aliases

Create Macros

After creating variables, you are ready to create macros. Typically, for every macro that you create that configures something, you need to create a corresponding macro to unconfigure it. The unconfiguration macro is usually the same command as the configuration command but with the word "no" in front of it. You link the configuration macro to a Deploy Network event, and you link the unconfiguration macro to an Undeploy Network event.

For the purposes of this scenario, you will only create configuration macros. You will create a macro to configure CSM and another macro to add real servers. Then, you will link these macros to the Deploy Network event.

This macro uses the config() subroutine. In addition, the get_ip() and get_mask() subroutines are used to extract the IP address and IP mask from the combined IPAddrResourceType variable.

Procedure

Step 1 Select Design > Templates.

Step 2 Open the template you just created, if it is not already open.

Step 3 Select the logical element for which you want to create macros. For this scenario, select the load balancer logical element from the template map area. The Macro Assignments tab opens.

Step 4 Click Macros & Variables. The Macros/Variables/Aliases dialog box opens with the Macros tab selected.

Step 5 Right-click the macro file container that you just created, named CSM, and select Create Macro. The Edit Macro dialog box opens.

Step 6 Create the macro to configure CSM by entering the following information in the fields:

•Name—Enter a name for the macro. In this case, enter config_csm as the name.

•Description—Enter a description for the macro. In this case, enter Configures CSM in bridge mode as the description.

•Event type—Select an event from the drop-down list. The event you choose causes this macro to run. For example, select the Deploy Network event.

•Target Device Type—Select the target device or module upon which the macro is run from the drop-down list. In this case, select CSM.

•Macro Body—Enter the macro instructions and CLI into the macro body. For this scenario, enter the following:
# Config csm server vlan 
sub config_server_vlan {
   config ("
      vlan  $ServerVlanID $ServerVlanType
      ip address ${\&get_ip($ServerVlanIP->{IPAddress}, INFO)}  
${\&get_mask($ServerVlanIP->{IPAddress})}
    ");
}
# Config csm client vlan 
sub config_client_vlan {
   config ("
      vlan  $ClientVlanID $ClientVlanType
      ip address ${\&get_ip($ClientVlanIP->{IPAddress}, INFO)}  
${\&get_mask($ClientVlanIP->{IPAddress})} 
      gateway ${\&get_ip($ClientVlanGtw->{IPAddress}, INFO)}
     ");
}
# Config csm serverfarm(s) & probe
sub config_serverfarm {
   config ("
      serverfarm $ServerFarmName
   ");
} 
# config csm vserver service 
sub config_vserver {
      config ("
         vserver $VServerName
         virtual ${\&get_ip($VServerIP->{IPAddress}, INFO)}  any 
         serverfarm $ServerFarmName
         inservice
      ");
 }
sub config_csm {
   config_server_vlan;
   config_client_vlan;
   config_serverfarm;
   config_vserver;
}
Step 7 Click OK.

Step 8 From the Macros/Variables/Aliases dialog box, right-click the macro file container, named CSM, and select Create Macro. The Edit Macro dialog box opens.

Step 9 Create the macro to add real servers by entering the following information in the fields:

•Name—Enter a name for the macro. In this case, enter add_realserver as the name.

•Description—Enter a description for the macro. In this case, enter Adds real servers as the description.

•Event type—Select an event from the drop-down list. The event you choose causes this macro to run. For example, select the Deploy Network event.

•Target Device Type—Select the target device or module upon which the macro is run from the drop-down list. In this case, select CSM.

•Macro Body—Enter the macro instructions and CLI into the macro body. For this scenario, enter the following:
sub add_realserver {
   config ("
      serverfarm $ServerFarmName
      real ${\&get_ip($RealServerIP->{IPAddress}, INFO)}
      inservice
   ");
}
Step 10 Click OK. Figure 11-16 shows the Macros tab listing the new macros.

Figure 11-16 CSM-Template Macros

Assign Macros to Events and Targets

After creating macros, you need to attach them to the targets upon which they will run and to the events that will trigger them.

This scenario uses the Deploy Network event as an example. When the Deploy Network event occurs, VFrame runs the config_csm macro on the CSM target. In your own network, you will need to create unconfiguration and verification macros and attach them to the Undeploy Network and Verify Network events.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 Open the template you just created, if it is not already open.

Step 3 Select the load balancer logical element in the template map work area. The Macro Assignments tab opens.

Step 4 Click the Associate macro button. The Edit Macro assignment dialog box opens.

Step 5 Do the following:

a. Select the target and event to which you want to assign the macro. For this scenario, select CSM as the target and Deploy Network as the event.

b. Select a macro. In this case, select the config_csm macro.

c. Click OK.

Step 6 Repeat Step 5 to assign the add_realserver macro to the CSM target and the Start Server event.

Figure 11-17 shows the config_csm and add_realserver macros assigned to the Deploy Network event and the CSM target.

Step 7 Click Save. Figure 11-17 shows the Macro Assignments tab listing the new macro assignments.

Figure 11-17 CSM-Template Macro Assignments

Validate Your Service Network Template

You are ready to validate your service network template after you have done the following:

•Created your service network template.

•Created any necessary variables, aliases, and macros.

•Assigned macros to events and targets.

Validating your service network template ensures that you have created and assigned all the necessary variables and resources to your template. Any assignments that cannot be resolved are identified so that you can return to the template and correct them. You must correct any errors before you can save and publish your template.

For detailed information about service network template validation, see Template Validation Results Dialog Box.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 Open the template you just created, if it is not already open.

Step 3 Click Validate. The Template Validation Results dialog box opens. In this case, your service network template has no errors, as shown in Figure 11-18.

Figure 11-18 Validation Results Dialog Box

Save and Publish Your Service Network Template

After validating your service network template and correcting any errors, you are ready to save and publish it. Publishing your template makes the template available for you or others to design actual service networks based on your template.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 Open the template you just created, if it is not already open.

Step 3 Click Save.

Step 4 Click Publish. In the Service Templates selector, the status of your service network is updated to Published, as shown in Figure 11-19.

Step 5 To continue to design your service network, see Designing a Service Network—Scenario.

Figure 11-19 Published CSM-Template

Working with Service Network Templates

The following topics help you work with service network templates:

•Creating and Modifying Service Network Templates

•Validating Service Network Templates

•Saving and Publishing Service Network Templates

•Deleting Service Network Templates

•Cloning Service Network Templates

•Exporting and Importing Service Network Templates

Creating and Modifying Service Network Templates

Service network templates provide a basic structure that you can use to design one or more service networks. They are made up of logical elements (such as Firewall Services Modules, switches, load balancers, and server groups) and endpoints (links).

You create service network templates by creating a network map that includes the elements required for your service. You then define basic information about your template and the elements within it. This basic information, along with other information supplied later when creating and starting your service network, is used to acquire and manage the elements in your service network.

After you create a service network based on a service network template, there are certain restrictions to the changes that you can make to the template. For details, see Understanding Service Network Templates.

For a scenario showing how to create a sample service network template, see Creating a Service Network Template—Scenario.

Before You Begin

•Determine your basic service network design, for example, the types of logical elements and links that are needed.

•Determine whether you need to create macros and variables. When you create a template, VFrame automatically configures ports and VLANs. If your service network design requires additional features, you must create macros and variables to configure these additional features. For more information, see Macros and Variables.

Procedure

Step 1 Select Design > Templates to open the Templates tab (see Templates Tab).

Step 2 Do one of the following:

•To create a new template, click New. The Input dialog box appears. Enter the template name in Template Name field. The template opens and its name appears in Service Templates selector and in a tab above the template topology work area.

•To modify an existing template, double-click the desired template from the Service Templates selector. The template opens and its definitions are displayed in the right panes.

Step 3 Drag and drop the desired logical element icons into the template topology work area. For more information about logical elements, see Understanding Service Network Templates.

Step 4 To connect two logical elements, draw a link between them. To do this, click the Connect button, click the first logical element, and then click the second logical element.

Step 5 Depending on your template design, define template parameters by selecting the template in the Elements selector and doing any of the following:

•Click the Macro Map tab to associate macros with events and targets for the template as a whole. You can also change the order of events and macros using this tab. For details, see Creating Macro Assignments and Ordering Macro Execution.

Note Alternatively, you can associate macros and target devices with events for specific logical elements from the Macro Association tab (see Creating Macro Assignments).

•Click the Properties tab to display information and enter a description about the selected service network template. This tab also provides access to the Macros/Variables/Aliases dialog box, which allows you to import, create, edit, and delete macros and create, edit, and delete variables and aliases. For details, see Working with Macros, Working with Variables, and Working with Aliases.

•Click the Events tab to add, edit, view, or delete events. For details, see Working with Events.

Step 6 Depending on your network design, define element parameters by selecting elements from the Elements selector and doing any of the following:

•Click the Macro Assignments tab to manage macro assignments. Using this tab, you can also import, create, edit, and delete macros for elements that support macros and create, edit, and delete variables and aliases.

For details, see Working with Macros, Working with Variables, and Working with Aliases.

•Click the Supported Targets tab to display and define constraint types and values (resource types and values) for the selected logical element.

Note The tabs that are displayed depend on whether you selected a logical element or endpoint and the type of endpoint that you selected.

Step 7 After you finish defining or modifying your template, click Save. The template is automatically validated and saved to the database.

If no errors are encountered during the validation, you can publish your template. Proceed to Step 9. If errors are encountered, you can still save your template, but you cannot publish it. You need to correct the errors first. To identify the errors, proceed to Step 8.

The template state remains at Designing, and you can return to edit it at any time. For more information about template states, see Service Network Template States.

Step 8 Validate your template by clicking Validate. The results are displayed in the Template Validation Results dialog box. For details about this dialog box, see Template Validation Results Dialog Box. You must correct any errors before you can use the template to define service networks.

Note Before proceeding, save any changes by clicking Save.

Step 9 After you successfully validated the template, click Publish. The template state changes to Published, and it can now be used to define service networks.

Related Topics

•Understanding Service Network Templates

•Creating a Service Network Template—Scenario

Validating Service Network Templates

Before you can publish a template and use it to create service networks, you must validate it.

Note Your template is also validated automatically when you save it. During this process, if the template validates successfully, the state changes to Validated. Otherwise, the template remains in the Designing state, and you must manually validate your template in order to display any errors in the Template Validation Results dialog box.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 From the Template Design tab, create a new template or open an existing template.

Step 3 After you finish creating the template or making changes, click Validate. The Template Validation Results dialog box opens. For details, see Template Validation Results Dialog Box.

If errors are found, they must be corrected before you can save and publish the template.

Related Topics

•Understanding Basic Templates

•Understanding Service Network Templates

Saving and Publishing Service Network Templates

You can save your template after you finish making changes, and open it again later to make additional changes, or you can place your template in the Published state so that it can be used to create service networks.

Before You Begin

•Make sure to validate and save the template before publishing it. For details, see Validating Service Network Templates.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 From the Template Design tab, create a new template or open an existing template.

Step 3 Do one of the following:

•To save your changes and continue to work on your template later, click Save.

•If you are done making changes to your template and want to begin using it to design service networks, click Save. The template is automatically validated and saved to the database.

During this process, if the template validates successfully, the state changes to Validated. Otherwise, the template remains in the Designing state, and you must manually validate your template in order to display any errors in the Template Validation Results dialog box.

If no errors are encountered during the validation, you can publish your template by clicking Publish. If errors are encountered, you can still save your template, but you cannot publish it.

Related Topics

•Understanding Service Network Templates

•Validating Service Network Templates

Deleting Service Network Templates

If you no longer need a template, you can delete it.

Before You Begin

•Make sure the template is not being used by a service network. You cannot delete a template if it is being used by a service network.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 Select the desired template and click Delete.

Related Topics

•Understanding Service Network Templates

Cloning Service Network Templates

You can clone service network templates. Cloning means you duplicate a template and assign it a different name. Cloning allows you to create a new template from an existing one that has most of the design elements you need. You need only make the changes and additions required for the new template.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 Select the template you want to clone and click Clone.

Step 3 Name the new template and click OK.

Related Topics

•Understanding Service Network Templates

Exporting and Importing Service Network Templates

You can share service network templates with other VFrame servers and other contexts. To do so, you export the template, and then import it into the desired VFrame server or context.

Before You Begin

•When importing a template, make sure that all new variables are aliased.

•Make sure the template has been validated. Only validated templates can be exported.

Procedure

Step 1 Select Design > Templates to open the Templates tab.

Step 2 Do one of the following:

•To export a template, select the desired template from the Service Templates selector and click Export. Name the template, navigate to the directory in which you want to save the file, and then click Export again.

•To import a template, click Import. Navigate to the desired directory and select the file. Leave the existing filename or rename the file, and then click Import again.

Note When you import a template, VFrame checks to make sure the template version is supported on the VFrame to which you are importing the template. If it is not supported, an error occurs, and the template is not imported. If this happens, you will need to recreate the template.

Related Topics

•Understanding Service Network Templates

Troubleshooting Service Network Template Design

These are some problems you might encounter when working with service network templates and their solutions:

•Validation of your template reports that a referenced macro could not be found in a logical element's macro file container.

•Validation of your template reports an error indicating that certain variables must be shared.

•Validation of your template reports an error indicating that transparent load balancers must have exactly two links.

•Validation of your template reports an error indicating that you have empty variable groups.

•Validation of your template reports an error that an alias has a variable set as the primary variable, but the macro using the alias is not associated with a logical element.

•Validation of your template reports an error that certain aliases do not have at least two variables.

•Macro file container cannot be imported because of an error indicating that a variable group type within the macro file container cannot be resolved.

•Changes to a template made in the Incremental Change state are not reflected in service networks that were created previous to the change.

•VFrame skipped configuring a device due an OS version mismatch, but the service network entered the Running state anyway.

Problem   Validation of your template reports that a referenced macro could not be found in a logical element's macro file container.

Solution   Either delete the reference to the macro or add the macro file container that is missing to the logical element, and then rerun validation.

Problem   Validation of your template reports an error indicating that certain variables must be shared.

Solution   A macro file container with a variable set to not be shared was imported into a logical element that required all variables to be shared. You must change the variable in the macro file container to be shared.

Problem   Validation of your template reports an error indicating that transparent load balancers must have exactly two links.

Solution   If you originally configured the load balancer to be in routed mode and added more than two links to it, and then changed the load balancer to transparent mode without removing links, VFrame reports an error. You must choose whether you want the load balancer to be in routed mode, in which case more than two links is allowed, or whether you want the load balancer to be in transparent mode, in which case only two links are allowed.

Problem   Validation of your template reports an error indicating that you have empty variable groups.

Solution   All variable groups, except the default variable group, must have at least one variable in them. You must either add a variable to the variable group or delete the variable group.

Problem   Validation of your template reports an error that an alias has a variable set as the primary variable, but the macro using the alias is not associated with a logical element.

Solution   You must either assign the macro to a logical element or choose another variable to be the primary variable.

Problem   Validation of your template reports an error that certain aliases do not have at least two variables.

Solution   The variable could have been mistakenly deleted when you deleted the variable, variable group, macro file container, logical element, or link on which the variable was used. You must either delete the alias or add another variable to the alias.

Problem   Macro file container cannot be imported because of an error indicating that a variable group type within the macro file container cannot be resolved.

Solution   A user-created variable group type has been deleted from the global library. Either recreate the variable group type in the global library, or delete the variable group from the macro file container, and then import the macro file container.

Problem   Changes to a template made in the Incremental Change state are not reflected in service networks that were created previous to the change.

Solution   In this case, VFrame is working correctly. Only new service networks created after you made the change to the template will contain the changes.

Problem   VFrame skipped configuring a device due an OS version mismatch, but the service network entered the Running state anyway.

Solution   This is normal behavior. You probably entered a specific OS version (or specific OS versions) in the macro for the device. In this case, when deploying your service network, VFrame only runs the macro on devices that match the OS version or versions you specified. If there are devices with OS versions that do not match the version or versions specified, VFrame logs a warning but allows the service network to enter the Running state. To prevent this situation, you can do one of the following:

•Do not specify specific OS versions if you have devices with several different versions in your service network. This solution is only possible if the commands used in the macro are compatible with all of the device OS versions.

•Create macros for each device with a different OS version and specify the specific OS version for each macro.

Storage Manager Templates

The following topics provide detailed information about storage manager templates:

•Creating Storage Manager Templates and Storage Managers—Basic Workflow

•Understanding Storage Manager Templates

•Working with Storage Manager Templates and Storage Managers

•Storage Managers Tab

Creating Storage Manager Templates and Storage Managers—Basic Workflow

Table 11-7 is an overview of the steps you take to create a storage manager template and storage manager in VFrame.

Table 11-7 Creating Storage Manager Templates and Storage Managers—Basic Workflow

Task

Step 1

Create a storage manager template (see Creating and Modifying Storage Manager Templates). As part of this task and depending on your storage manager template design, do the following, as required:

•Create variables and variable groups (see Creating, Editing, and Deleting Variable Groups).

•Create variable aliases (see Creating and Editing Aliases).

•Create macros (see Creating, Editing, and Viewing Macros).

•Assign macros to events and targets (see Creating Macro Assignments).

Step 2

Save your storage manger template by clicking Save.

Step 3

Define your storage manager (see Defining Storage Managers).

Understanding Storage Manager Templates

When you set up VFrame, you can choose whether you want to obtain required information about your storage arrays through MDS switches (fabric mode) or through storage managers (storage array mode). If you choose to manage storage arrays through storage managers, you must use the default storage templates or create your own storage templates. You then define the storage managers you want to use.

Storage templates and storage manager definitions together provide VFrame with the necessary information to discover storage managers and perform LUN masking and LUN unmasking on associated storage arrays.

The following topics help you understand these concepts:

•Default Storage Manager Templates

•User-Defined Storage Manager Templates

•Storage Managers

Default Storage Manager Templates

The following default storage templates perform LUN masking, LUN unmasking, and storage inventory retrieval:

•CLARiiON—Storage template used for CLARiiON storage managers.

•DMX—Storage template used for Symmetrix storage managers.

To obtain more information about the default storage templates, select Design > Storage Managers and select one of the default templates from the Storage Manager Templates selector. The Macro Assignments tab opens showing the macros with their associated targets and events, contained in the template.

You can view macro details by clicking Macros & Variables. From the Macros tab, select the macro that you are interested in viewing and click the Edit button. The Edit Macro dialog box appears containing information about the macro including the macro body and variables associated with the macro.

Tip If one of the default storage templates only needs minor changes to meet your needs, clone it and make changes to the copy. For details, see Cloning Storage Manager Templates.

User-Defined Storage Manager Templates

If the default storage templates do not meet your needs, you need to create your own storage templates, which include macros that perform these required operations:

•Discover storage managers

•Mask LUNs

•Unmask LUNs

•Verify LUN masking

•Verify LUN unmasking

You then associate these macros with related events, such as discovery (Inventory event), masking LUNs (Mask LUN event), unmasking LUNs (Unmask LUN event), and verification of LUN masking and unmasking (Mask LUN and Unmask LUN events). For example, you associate the macro that discovers your storage manager with an Inventory event. In this way, when you perform a discovery, VFrame detects an Inventory event and it performs the associated macro and discovers your storage manager. (You can also create additional macros that you can associate with these or other events.)

In order to create storage templates, you should understand the basic components of templates. See Understanding Basic Template Components. For details about creating storage templates, see Creating and Modifying Storage Manager Templates.

Tip If one of the default storage templates only needs minor changes to meet your needs, clone it and make changes to the copy. For details, see Cloning Storage Manager Templates.

Storage Managers

Regardless of whether you use the default storage templates or create your own, you also must tell VFrame some information about the storage managers that you want to use. You need to define the storage manager's physical IP address, SSH port, and the directory location of the storage manager application. For details, see Defining Storage Managers.

Working with Storage Manager Templates and Storage Managers

The following topics help you work with storage templates:

•Creating and Modifying Storage Manager Templates

•Deleting Storage Manager Templates

•Cloning Storage Manager Templates

•Exporting and Importing Storage Manager Templates

•Defining Storage Managers

Creating and Modifying Storage Manager Templates

If you choose to manage storage arrays through storage managers, you must create storage manager templates. You then must define the storage managers you want to use. After doing this, you can discover your storage managers.

Before You Begin

•Determine the type of storage manager you have.

•Determine whether you can use the macros and variables provided by VFrame.

•If your storage manager requires additional features, you must create macros and variables to configure these additional features. For more information, see Working with Macros and Working with Variables.

Procedure

Step 1 Select Design > Storage Managers to open the Storage Managers tab (see Storage Managers Tab).

Step 2 Do one of the following:

•To create a new storage template, click New. The Storage Manager dialog box appears. Enter the name and type of storage manager in the appropriate fields and click OK.

•To modify an existing template, click the desired template from the Storage Manager Templates selector. The template opens and its definitions are displayed in the right pane.

Step 3 If you plan to use the macros provided with VFrame, proceed to Step 4. If you plan to create your own macros, you can do so in one of two ways:

•To create macros within VFrame, see Creating, Editing, and Viewing Macros.

•To create macros outside of VFrame, you must use your own XML editor, then import them into VFrame. See Importing Macro File Containers.

Step 4 Associate the macros to your storage manager target. For details, see Creating Macro Assignments.

Step 5 When you are done defining or modifying your storage template, click Save. The template is saved to the database.

Step 6 Define the storage managers that will use this storage template. See Defining Storage Managers.

Related Topics

•Understanding Storage Manager Templates

•Defining Storage Managers

Deleting Storage Manager Templates

If you no longer need a storage template, you can delete it.

Before You Begin

•Make sure that the storage template is no longer required.

Procedure

Step 1 Select Design > Storage Managers to open the Storage Managers tab.

Step 2 Select the desired storage template and click Delete.

Related Topics

•Understanding Storage Manager Templates

•Working with Storage Manager Templates and Storage Managers

Cloning Storage Manager Templates

You can clone storage templates. Cloning means you duplicate a template and assign it a different name. Cloning allows you to create a new template from an existing one that has most of the design elements you need. You need only make the changes and additions required for the new template.

Procedure

Step 1 Select Design > Storage Managers to open the Storage Managers tab.

Step 2 Select the template that you want to clone and click Clone.

Step 3 Name the new template and click OK.

Related Topics

•Understanding Storage Manager Templates

•Working with Storage Manager Templates and Storage Managers

Exporting and Importing Storage Manager Templates

You can share storage templates with other VFrame servers and other contexts. To do so, you export the template, and then import it into the desired VFrame server or context.

Procedure

Step 1 Select Design > Storage Managers to open the Storage Managers tab.

Step 2 Do one of the following:

•To export a template, select the desired template from the Template List selector and click Export. Name the template, navigate to the directory in which you want to save the file, and then click Export again.

•To import a template, click Import. Navigate to the desired directory and select the file. Leave the existing file name or rename the file, and then click Import again.

Note When you import a template, VFrame checks to make sure the template version is supported on the VFrame data center to which you are importing the template. If it is not supported, an error occurs, and the template is not imported. If this happens, you will need to recreate the template.

Related Topics

•Understanding Storage Manager Templates

•Working with Storage Manager Templates and Storage Managers

Defining Storage Managers

If you choose to manage storage arrays through storage managers, you must define information about the storage managers you want to use.

Before You Begin

•You must create a storage template that applies to the type of storage manager you want to use. For details, see Creating and Modifying Storage Manager Templates.

Procedure

Step 1 Select Design > Storage Managers to open the Storage Managers tab.

Step 2 Select the desired storage template from the Storage Manager Templates selector.

Step 3 Click New.

Step 4 In the Storage Manager dialog box:

•Enter a name for the storage manager.

•Enter the IP address and SSH port number for VFrame to use to connect with the storage manager.

•If you have high availability set up, enter the secondary IP address and SSH port number.

•Enter the path where the storage manager application is located and click Ok.

Step 5 Click Save. You can now discover your storage managers. See Discovering Storage Devices, page 6-8.

Related Topics

•Understanding Storage Manager Templates

•Discovering Storage Devices, page 6-8

LOM Manager Templates

The following topics provide detailed information about LOM manager templates:

•Creating LOM Manager Templates and LOM Managers—Basic Workflow

•Understanding LOM Manager Templates

•Working with LOM Manager Templates

•Troubleshooting LOM Manager Templates

•LOM Managers Tab

Creating LOM Manager Templates and LOM Managers—Basic Workflow

Table 11-7 is an overview of the steps you take to create a LOM manager template and LOM manager in VFrame.

Table 11-8 Creating LOM Manager Templates and LOM Managers—Basic Workflow

Task

Step 1

Create a LOM manager template (see Creating and Modifying LOM Manager Templates). As part of this task and depending on your LOM manager template design, do the following as required:

•Create variables and variable groups (see Creating, Editing, and Deleting Variable Groups).

•Create variable aliases (see Creating and Editing Aliases).

•Create macros (see Creating, Editing, and Viewing Macros).

•Assign macros to events and targets (see Creating Macro Assignments).

Step 2

Save your storage template by clicking Save.

Step 3

Define your LOM manager (see Defining LOM Managers).

Understanding LOM Manager Templates

Among other functions, VFrame needs to be able to power on and off the servers it manages. Typically, this is done using a LOM manager. LOM managers provide power on and power off functions for the remote servers they manage. For more information, see LOM Managers.

A LOM manager can be the VFrame Data Center Director or an external Linux device that contains the necessary third-party client software and configuration. For specific information about setting up the VFrame Data Center Director as the LOM manager, including steps for creating the required LOM inventory file, see Configuring VFrame as a LOM Manager. For information about setting up a third-party client software and configuration on a Linux device, see Setting Up Independent LOM Managers.

Default LOM Manager Templates

VFrame provides some default LOM manager templates for you to use. The following default LOM manager templates provide power on, power off, power status, and inventory functions:

•APC—Provides configuration macros which use the APC SNMP interface to control server power functions.

•DELL_DRAC4—Provides configuration macros for managing Dell servers with DRAC 4 installed.

•DELL_DRAC5—Provides configuration macros for managing Dell servers with DRAC 5 installed.

•HP_iLO—Provides configuration macros for managing HP servers with iLO or iLO2 installed.

•IBM_RSA2—Provides configuration macros for managing IBM servers with RSAII SlimeLine support.

•IBM_BC—Provides configuration macros for managing IBM blade servers within an IBM Blade Center.

To obtain more information about the default LOM manager templates, select Design > LOM Managers and select one of the default templates from the LOM Manager Templates selector. The Macro Assignments tab opens, showing the macros, with their associated targets and events, contained in the template.

You can view macro details by clicking Macros & Variables. From the Macros tab, select the macro you are interested in viewing and click the Edit button. The Edit Macro dialog box appears containing information about the macro including the macro body and variables associated with the macro.

User-Defined LOM Manager Templates

If the default LOM manager templates do not meet your needs, you can create your own LOM manager templates. In this case, you create customized macros providing the commands that enable VFrame to communicate with your LOM manager. You must create macros for the following functions and associate them with their respective events:

•Power on—Power Server On event

•Power off—Power Server Off event

•Power status—Get Server Power Status event

•LOM Inventory—Inventory event

Before creating LOM manager templates, it is a good idea that you understand the basic concepts of templates. For details, see Understanding Basic Template Components. For details about creating LOM manager templates, see Creating and Modifying LOM Manager Templates.

Working with LOM Manager Templates

The following topics help you work with LOM manager templates:

•Creating and Modifying LOM Manager Templates

•Deleting LOM Manager Templates

•Exporting and Importing LOM Manager Templates

•Defining LOM Managers

Creating and Modifying LOM Manager Templates

VFrame needs to be able to power on and power off the servers it manages. If the LOM manager templates provided by VFrame do not meet your needs, you need to create your own LOM manager template.

Before You Begin

•Understand LOM manager templates. For details, see Understanding LOM Manager Templates.

•Determine the types of servers you have. If you have servers from different vendors, you might have different LOM managers for each vendor as well. If this is the case, you need to create a LOM manager template for each type of LOM manager you have.

•Determine whether you can use the LOM manager templates provided by VFrame.

Procedure

Step 1 Select Design > LOM Managers to open the LOM Managers tab.

Step 2 Do one of the following:

•To create a new LOM manager template, click New. The LOM Manager dialog box appears. Enter the appropriate information in the fields and click OK.

•To modify an existing template, click the desired template from the LOM Manager Templates selector. The template opens and its definitions are displayed in the right pane.

Step 3 If you plan to use the macros provided with VFrame, proceed to Step 4. If you plan to create your own macros, you can do so in one of two ways:

•To create macros within VFrame, see Creating, Editing, and Viewing Macros.

•To create macros outside of VFrame, you must use your own XML editor, and then import them into VFrame. See Importing Macro File Containers.

Step 4 Associate the macros to your LOM manager target. For details, see Creating Macro Assignments.

Step 5 When you are done defining or modifying your LOM template, click Save. The template is saved to the database.

Step 6 Define the LOM managers that will use this LOM template. See Defining LOM Managers.

Related Topics

•Understanding LOM Manager Templates

•Defining LOM Managers

Deleting LOM Manager Templates

If you no longer need a LOM manager template, you can delete it.

Before You Begin

•Make sure that the LOM manager template is no longer required.

Procedure

Step 1 Select Design > LOM Managers to open the LOM Managers tab.

Step 2 Select the desired LOM manager template and click Delete.

Related Topics

•Understanding LOM Manager Templates

•Working with LOM Manager Templates

Exporting and Importing LOM Manager Templates

You can share LOM manager templates with other VFrame servers and other contexts. To do so, you export the template and then import it into the desired VFrame server or context.

Procedure

Step 1 Select Design > LOM Managers to open the LOM Managers tab.

Step 2 Do one of the following:

•To export a template, select the desired template from the LOM Manager Templates selector and click Export. Name the template and navigate to the directory in which you want to save the file, then click Export again.

•To import a template, click Import. Navigate to the desired directory and select the file. Leave the existing filename or rename the file, and then click Import again.

Note When you import a template, VFrame checks to make sure that the template version is supported on the VFrame data center to which you are importing the template. If it is not supported, an error occurs, and the template is not imported. If this happens, you will need to recreate the template.

Related Topics

•Understanding LOM Manager Templates

•Working with LOM Manager Templates

Defining LOM Managers

After choosing one of the LOM manager templates provided by VFrame or creating your own LOM manager template, you must define specific information about the LOM manager you plan to use.

Before You Begin

•Determine if you have your LOM managers configured for failover. If you do, you must know the IP address or hostname of the primary and secondary LOM managers.

Procedure

Step 1 Select Design > LOM Managers to open the LOM Managers tab.

Step 2 Select the desired LOM manager template from the LOM Manager Templates selector.

Step 3 Click New.

Step 4 Enter the primary and secondary IP address for VFrame to use to connect with the LOM manager.

Note Entering a value for the primary IP address is mandatory; whereas, entering a value for the secondary IP address is optional. VFrame uses the secondary IP address whenever the primary IP address is not reachable. This setup allows the secondary IP address to serve as a backup and helps avoid failures while performing maintenance procedures on LOM managers. For details, see Maintaining LOM Managers.

Step 5 Enter the primary and secondary SSH port of the LOM manager and click OK.

The new LOM manager appears in the LOM Manager Templates selector under the LOM logical element to which it is associated.

Step 6 In the Variable Values tab, enter the LOM inventory filename, including the path to the directory where the file is stored. The LOM inventory file is a listing of physical servers and their LOM interfaces and is created as part of the network setup. For more information about creating this file, see Discovering Application Servers for Unassociated LOM Interfaces, page 6-15.

Step 7 If your LOM manager has other specific functions, you might have to define other variable values. Define these values, as required.

Step 8 Click Save.

Step 9 You can now discover your LOM managers. See Discovering Application Servers for Unassociated LOM Interfaces, page 6-15.

Related Topics

•Understanding LOM Manager Templates

•Creating and Modifying LOM Manager Templates

Troubleshooting LOM Manager Templates

These are some problems you might encounter when working with LOM Manager templates and their solutions:

•When performing a power on, power off, or update power status operation, it fails.

•Primary LOM manager IP address is not reachable.

•Discovery of LOM interfaces fails.

Problem   When performing a power on, power off, or update power status operation, it fails.

Solution   There can be several reasons why these operations could fail. Check the following:

•Make sure that the primary or secondary IP address you entered for the LOM manager matches the IP address or IP address range specified in the LOM manager credentials page.

•If you are using hostnames as the LOM manager primary or secondary IP address, must make sure that the credentials correspond to the IP addresses of these hostnames.

For example, the hostname, vfdc-1.cisco.com, corresponds to the IP address 192.188.10.10. You specify the hostname, vfdc-1.cisco.com, for the LOM manager. Therefore, you need to specify LOM manager credentials that match 192.188.10.10, either by specifying the exact IP address, a range of IP addresses, or wild cards.

•LOM interfaces (iLO interfaces) have restrictions on the number of simultaneous connections they can accept. If you manually open SSH connections to LOM interfaces, VFrame LOM managers are not able to connect to them when the limit is exceeded, and an error occurs.

Problem   Primary LOM manager IP address is not reachable.

Solution   This situation can occur when you are using VFrame as the LOM manager with a NAT address specified as the IP address or hostname. You need to make sure that the NAT address is routable and reachable. If this is not possible, use an internal IP address instead.

Problem   Discovery of LOM interfaces fails.

Solution   Check the discovery Job Logs tab. If an error indicating that the specified inventory file could not be found exists, make sure that the path and name of the inventory file that you specified for your LOM manager is correct. Click the LOM Manager Templates tab and then select the desired LOM manager. Verify the entry in the LOM Inventory File Name field.

Template Design Reference

The following topics provide reference information for these tabs:

•Templates Tab

•Storage Managers Tab

•LOM Managers Tab

Templates Tab

Use the Templates tab to create and manage service network templates.

How to Get to This Tab

Select Design > Templates to open the Templates tab.

Related Topics

•Understanding Service Network Templates

•Creating a Service Network Template—Scenario

•Working with Service Network Templates

Field Reference

Table 11-9 Templates Tab

Element

Description

Buttons

New button

Click this button to create a new template. The Input dialog box opens so that you can define the name of the template.

Open button

Click this button to open the selected template.

Delete button

Click this button to delete the selected template.

Save button

Click this button to save changes made to the open and selected template.

The template is automatically validated and saved to the database. If no errors are encountered during the validation, you can publish your template. If errors are encountered, you can still save your template, but you cannot publish it. You need to validate the template by clicking the Validate button and correct any errors first.

Validate button

Click this button to validate the template. Results appear in the Template Validation Results dialog box. For details, see Template Validation Results Dialog Box.

Publish button

Click this button to allow the template to be used to design service networks.

Clone button

Click this button to duplicate the selected template and assign it a different name.

Import button

Click this button to import a template that has already been created. Make sure that the VFrame version that you created the template in matches the VFrame version that you are importing to. These versions must match for the import to be successful.

Export button

Click this button to export a saved template so that it can be imported into another virtual context or VFrame.

Selector

Service Templates selector

Lists the service network templates that have been created. Double-click the name of a template to open the template definition pane for that template.

Selected service template selector

Lists the logical elements and links that have been assigned to the selected service network template.

Template Topology Work Area—Add elements to or remove elements from the template.

Tools

Click a button to perform the desired action:

•Pan button—Click this button to move the viewable area of the template. Click the Pan button, and then click and hold the left mouse button and drag the image to the desired position.

•Select button—Click this button to select the template or an item (element or link) within the template.

Click the Select button, and then right-click the template topology work area to select the template or the desired item. To select multiple items within a template, right-click the item then hold down the Shift key while right-clicking additional items.

Selecting the template or an element within the template displays its corresponding information in the tabs below. Selecting multiple elements displays corresponding information for the last element selected. No information is provided for links. For more information about these tabs, see Table 11-15.

•Zoom in rect button—Click this button to zoom in on a selected area.

Click the Zoom in rect button, and then click and hold the left mouse button and drag it. A rectangle forms. Select the items you want to zoom in on. Release the left mouse button. The view zooms into the area contained by the rectangle.

•Zoom in button—Click this button to increase the size of the items displayed.

•Zoom out button—Click this button to decrease the size of the items displayed.

•Fit to view button—Click this button to resize all items and display them them within the viewable work area.

Elements

Do one of the following to add links and logical elements to the service network template:

•Click the Connect button to activate the link creation tool. Click one element and then the next element to draw a link between the two elements. If you accidently click the Connect button and want to deactivate it, click the Connect button again.

•Drag and drop these icons into the template topology work area:

–Firewall

–ExterNet

–Load balancer

–Server group

–Layer 2 switch

–Layer 3 switch

–Firewall (high availability)

–Layer 3 switch (high availability)

–Load balancer (high availability)

For a detailed description of these elements, see Service Network Template Elements.

Parameters— Define parameters for the service network template or selected element.

Template

Create a new template or open an existing service network template, and then click a tab to display or define template parameters:

•Macro Map tab—Enables you to associate macros with events and target devices for the template as a whole. The tab graphically displays events and the macros associated with them. For detailed reference information, see Macro Map Tab.

•Properties tab—Displays the name and state of the service network template. Also displays a hierarchical view of logical elements, targets, and macros. For detailed reference information, see Properties Tab.

•Events tab—Displays events that apply to each logical element within the template. Enables you to create, edit, and delete events. For detailed reference information, see Events Tab.

Element

Select an element from the service network template selector or from the service network template work area, and then click the desired tab to open and define element parameters:

Note You cannot select endpoints from the template topology work area. Attempting to select the endpoints in the template topology work area selects the link and displays service network template information, not link or end-point information.

•Macro Assignments—Enables you to assign macros to targets and events. Also allows you to create or import macro file containers and define variables, variable groups, and aliases. For detailed reference information, see Macro Assignments Tab.

•Supported Targets—Enables you to define constraint types and values (resource types and values). For detailed reference information, see Supported Targets Tab.

Macro Map Tab

Use the Macro Map tab to associate macros with events and targets for the template as a whole. The tab graphically displays events and the macros associated with them. You can also change the order of events and macros using this tab.

Note Alternatively, you can associate macros with event and targets for specific logical elements using the Supported Devices tab (see Supported Targets Tab).

How to Get to This Tab

From the Templates Tab, open a service network template and click the Macro Map tab.

Related Topics

•Macros

•Creating Macro Assignments

•Events

•Creating, Editing, and Viewing Events

•Ordering Events

Field Reference

Table 11-10 Macro Map Tab

Element

Description

Element Name

Name of the selected service network template.

Tools

Click a button to perform the desired action:

•Pan button—Click this button to move the viewable area of the macro map. Click the Pan button, and then click and hold the left mouse button and drag the image to the desired position.

•Select button—Click this button to select an item within the macro map.

Click the Select button, and then right-click the desired item. To select multiple items within a template, right-click the item then hold down the Shift key while right-clicking additional items.

•Zoom in rect button—Click this button to zoom in on a selected area.

Click the Zoom in rect button, and then click and hold the left mouse button and drag it. A rectangle forms. Select the items you want to zoom in on. Release the left mouse button. The view zooms into the area contained by the rectangle.

•Zoom in button—Click this button to increase the size of the items displayed.

•Zoom out button—Click this button to decrease the size of the items displayed.

•Fit to view button—Click this button to resize all items and display them them within the viewable work area.

Work area

Graphical display of event flows. An event flow begins with an event and is followed by the system actions, macros, and other events that are triggered as a result.

•Events—Designated by an E and the color green.

Right-click an event to edit the event, add a macro to it, or change the ordering of system actions, macros, and events attached to the selected event. For detailed reference information about the dialog boxes that open, see the following topics:

–Event Dialog Box

–Edit Macro Assignment Dialog Box

–Event Ordering Dialog Box

•Macros—Designated by a macro icon and the color yellow.

Right-click a macro to disassociate the macro from the event or to edit or view the macro. For detailed reference information about the Edit Macro dialog box, see Edit Macro Dialog Box.

After you validate your service network template, if applicable, one of the following icons appears in the top right corner of the macro block:

–Red circled X—Error detected in macro.

–File with arrow—Macro references additional macros. Double-click the macro block to display additional macros.

•System Actions—Designated by a system action icon and the color blue.

You cannot view, edit, or delete system actions.

Refresh button

Click this button to update the information displayed on the macro map.

Properties Tab

Use the Properties tab to display information and enter a description about the selected service network template. This tab also provides access to the Macros/Variables/Aliases dialog box, which allows you to import, create, edit, and delete macros and create, edit, and delete variables and aliases.

How to Get to This Tab

From the Templates Tab, open a service network template and click the Properties tab.

Related Topics

•Macros

•Working with Macros

•Variables

•Working with Variables

•Aliases

•Working with Aliases

Field Reference

Table 11-11 Properties Tab

Element

Description

Element Name

Name of the selected service network template.

Description

Word or phrase that describes the template.

Mappings

Hierarchical view of logical elements, resource types (constraints and constraint values), targets, and macros for the selected logical element.

Macros & Variables button

Click this button to open the Macros/Variables/Aliases dialog box. From this dialog box, you can import, create, edit, and delete macros and create, edit, and delete variables and aliases. For detailed reference information, see Macros/Variables/Aliases Dialog Box.

Events Tab

Use the Events tab to display and define events that apply to the service network and all of the logical elements within it. You can also create certain event types for some logical elements. For details, see Creating, Editing, and Viewing Events.

How to Get to This Tab

From the Templates Tab, create a new template or open an existing template, and then click the Events tab.

Related Topics

•Events

•Event Dialog Box

•Event Ordering Dialog Box

Field Reference

Table 11-12 Events Tab

Element

Description

Element Name

Name of the selected service network template.

Actions button

Select an item and click this button to open a context-sensitive drop-down menu of actions that you can perform. This menu is also available when you right-click an item.

Logical Element Events folders

Events that are generated by the specific logical element. System events are shown in bold. User-defined events are shown in regular text. For a list of system events, see Events.

You can do any of the following:

•Edit events—You can edit any event, whether it pertains to the service network or to a particular logical element. To edit an event, right-click it and select Edit/View.

•Delete events—You can delete events that you created. You cannot delete predefined events or events that are in use. To delete an event, right-click it and select Delete.

•Change the order of events and macros—To change the order of events or macros that are triggered as a result of the event, right-click the event and select Change Ordering. In the Event Ordering dialog box, use the up and down arrow buttons to change the order of the selected event or macro in relation to other events and macros.

Event Dialog Box

Use the Event dialog box to create and edit events.

How to Get to This Tab

From the Events Tab, right-click the desired event folder and select Add event or right-click the desired event and select Edit event.

Related Topics

•Events

•Creating, Editing, and Viewing Events

Field Reference

Table 11-13 Event Dialog Box

Elements

Description

Event Name

Name of the event.

Description

Word or phrase that describes the event.

Event Type

Type of event.

Error Handling

Select the Proceed on Error check box to show that you want to run another event if errors are found. If the check box is selected, the Event to Run on Error field appears, and you must click the list box to select the desired event.

Event Ordering Dialog Box

For service network templates, use this dialog box to place events in the order that you want them to be triggered and macros in the order that you want them to be run.

How to Get to This Tab

Do one of the following:

•From the Events Tab, right-click an event and select Change ordering.

•From the Macro Map Tab, right-click an event and select Change ordering.

Related Topics

•Events

•Ordering Events

•Macros

•Ordering Macro Execution

Field Reference

Table 11-14 Event Ordering Dialog Box

Element

Description

Event

Name of selected event.

Work area

List of system actions, macros, and events associated with the selected event.

Up and down arrow buttons

Select an event or a user-created macro and click the up or down arrow buttons to move the order in which events are triggered and macros are run.

Note You cannot change the order of system actions or move events and macros before system actions.

Macro Assignments Tab

Use the Macro Assignments tab to manage macro assignments. Using this tab, you can also import, create, edit, and delete macros for elements that support macros and create, edit, and delete variables and aliases.

How to Get to This Tab

From the Templates Tab, Storage Managers Tab, or LOM Managers Tab, create a new template or open an existing template, click a logical element, and then click the Macro Assignments tab.

Related Topics

•Macros

•Creating Macro Assignments

•Deleting Macro Assignments

Field Reference

Table 11-15 Macro Assignments Tab

Element

Description

Name

Name of the selected template.

Type

Type of template.

Target

Target to which macro is assigned.

Event

Event that triggers macro.

Macro

Name of macro.

Description

Word or phrase describing macro.

Macros & Variables button

Click this button to open the Macros/Variables/Aliases dialog box. From this dialog box, you can import, create, edit, and delete macros and create, edit, and delete variables and aliases. For detailed reference information, see Macros/Variables/Aliases Dialog Box.

New button

Click this button to create a macro assignment. For detailed reference information, see Edit Macro Assignment Dialog Box.

Delete button

Select a macro assignment and click this button to delete a macro assignment.

Macros/Variables/Aliases Dialog Box

Use this dialog box to import, create, edit, and delete macros and create, edit, and delete variables and aliases.

Note•The Macros tab is displayed only if the selected logical element supports macros.

•The actions you take on macros and variables affect only the macros and variables for the selected logical element. Whereas, the actions you take on aliases, affect all aliases in VFrame.

How to Get to This Tab

From the Properties Tab or the Macro Assignments Tab click the Macros & Variables button.

Related Topics

•Macros

•Working with Macros

•Variables

•Working with Variables

•Aliases

•Working with Aliases

Field Reference

Table 11-16 Macros/Variables/Aliases Dialog Box

Element

Description

Macros tab

Click this tab to import, create, edit, and delete macros. For detailed reference information, see Macros Tab.

Note The macros in this tab apply to the logical element that you have selected.

Variables tab

Click this tab to create, edit, and delete variables. For detailed reference information, see Variables Tab.

Note The variables in this tab apply to the logical element that you have selected.

Aliases tab

Click this tab to create, edit, and delete aliases. For detailed reference information, see Aliases Tab.

Macros Tab

Use the Macros tab to do the following:

•Create and export macro file containers.

•Import, create, edit, and delete macros.

Note The Macros tab is displayed only if the selected logical element supports macros.

How to Get to This Tab

From the Macros/Variables/Aliases Dialog Box, click the Macros tab.

Related Topics

•Macros

•Working with Macros

Field Reference

Table 11-17 Macros Tab

Element

Description

Create Container button

Click this button to create a macro file container. Enter the name, description, and author of the macro file container in the appropriate fields and click OK.

Import Macros button

Click this button to import macros that were created outside of VFrame or that were created from another VFrame server and exported.

Note Once you select the desired macro, you can click the Show Details button to open the Edit Macro dialog box and view the macro. For more details, see Edit Macro Dialog Box.

Export Container button

Click this button to export the selected macro file container to a location that is external to VFrame.

Create Macros button

Click this button to create a macro. For more information, see Edit Macro Dialog Box.

Edit button

Click this button to edit the selected macro. For more information, see Edit Macro Dialog Box.

Delete button

Click this button to delete the selected macro.

Edit Macro Dialog Box

Use this dialog box to create, edit, or view macros.

How to Get to This Dialog Box

Do one of the following:

•From the Macros Tab, navigate to the desired macro file container and click the New macro icon button.

•From the Macros Tab, navigate to the desired macro and click the Edit macro icon button.

•From the Macro Map Tab or the Supported Targets Tab, right-click a macro and select Edit/View macro.

Related Topics

•Macros

•Working with Macros

Field Reference

Table 11-18 Edit Macro Dialog Box

Element

Description

Name

Name of the macro.

Description

Word or phrase that describes the purpose of the macro.

Event Name

Name of the event.

Event Type

System-defined events. For a complete list of event types, see Events.

Target Device Type

Target device or module upon which the macro is run. Click the list box to display a list of target types.

Auto Correcting

Select this check box to show that the macro is capable of automatically correcting discrepancies it detects between what is expected and what actually exists on the device. Left unselected, the macro does not make any changes on the device.

This check box applies to verification macros only (macros triggered by Verify Network, Verify Server Group and Verify Server events). Verification macros run after a network is started to ensure that the changes made by configuration macros are in effect.

You must design the macro with the capability to correct discrepancies. If the check box is selected, but the macro is not designed in this fashion, it will not make corrections.

Comment

(Optional) Additional information about the macro.

OS Versions

Tags that define OS versions supported by the devices assigned to the macro in order for the macro to function properly. To use this field, do one of the following:

•Click Add to create a new OS version tag.

•Select the desired tag and click Edit to modify an existing tag or Delete to remove the tag.

When you add or edit an OS Version tag, the OS Version Editor dialog box appears. Click the Exact Value radio button to specify an exact version number or click the Version Pattern radio button to specify regular expression. A regular expression is a string that is used to describe or match a collection of values, according to certain syntax rules. Following are some common characters used to create regular expressions:

•. matches any character.

•* matches the previous character any number of times.

•+ matches the previous character 1 or more times.

•( ) is used for grouping.

•[ ] matches a single character listed inside the brackets. For example, c[oa]t will match cot and cat, but not coat.

•\ escapes a metacharacter. For example, \x will match an "x".

For example, to designate a macro for all CSMs running 4.2(5) OS version, you can use any of the folowing expressions:

•4\.2$5$—Matches 4.2(5) exactly.

•4\.2.*—Matches 4.2 followed by anything.

•4\..*—Matches 4. followed by anything.

Note If you specify an OS version or versions, you need to make sure that the devices in your network match the OS version or versions you specify. When deploying a service network, if VFrame detects a version mismatch, it logs a warning. However, this warning does not prevent the service network from entering the Running state. You might have some devices in your service network that are not configured with the expected macros.

External Macro References

Names of macros that are referenced from this macro. Click the New icon button to add macro references. Select a macro and click the Delete icon button to remove macro references.

Variables

Information about variables defined in the macro. From this field, you can create, edit, delete, and order variables and variable groups.

Note You cannot edit or delete the default variable group that was created when you created the macro file container. You can only change its order among the other variable groups and macros.

This field provides the same functions as the Variable tab. For more information about this field, see Variables Tab.

Macro Body

Perl content.

Variables Tab

Use the Variables tab to display and define variables and variable groups for the selected logical element or endpoint.

How to Get to This Tab

From the Macros/Variables/Aliases Dialog Box, click the Variables tab.

Related Topics

•Variables

•Working with Variables

Field Reference

Table 11-19 Variables Tab

Element

Description

Name

Names of variables, variable groups, macros, and macro file containers defined for the selected service network template logical element or endpoint, storage template, or LOM manager template. Displayed as a hierarchical tree to show relationships between items.

Variables shown in bold are default variables, and variables shown in plain text are user-created variables. For more details about default variables, see "System Actions, Default Variables, and Resource Attribute Variables."

Description

Word or phrase describing the variable, variable group, element, macro, or macro file container.

Type

Type of variable, as follows:

•Boolean—True or False.

•Date—Date in the format YY-MM-DD.

•Double—Double precision number, which can be defined as an integer, fixed-point number, or floating-point number.

•Float—Floating point number.

•IPAddrResourceType—IP address.

•Integer—Integer. You can define variable value restrictions that define minimum and maximum values or enumerate specific values.

•Long—Long integer.

•String—Sequence of simple objects. You can define variable value restrictions that define regular expressions or the enumerated values.

•Vlan—Name or number of VLANs discovered or created by VFrame.

IsShared

Indicates whether the variable value can be used by child elements, if any exist, such as servers in a server group. True means the variable can be shared, and False means the variable cannot be shared.

Multivalued

Indicates whether the variable is set to multivalue. True means the variable is set to multivalue, and False means it is not set to multivalue.

If a variable is set to multivalue, you must assign resource pools, not single values, as the value. For more information, see Understanding Variable and Variable Group Types

Optional

Indicates that a value is not required for the variable.

Default/Fixed Value

Value assigned to the variable, if present.

New button

Do one of the following:

•Select a macro file container and click this button to create a new variable group. For details, see Variable Group Dialog Box.

•Select the default variable group or a user-created variable group and click this button to create a new variable in the group. For details, see Variable Dialog Box.

Up and down arrow buttons

Select an item and click the up or down arrow buttons to move the order of the item. Changing the order of variables in a variable group changes their display order in the Service Networks tab.

Edit button

Select a variable or variable group and click this button to edit the variable or variable group. For details, see Variable Dialog Box and Variable Group Dialog Box.

Delete button

Select a variable or variable group and click this button to delete the variable or variable group.

Aliases Tab

Use the Aliases tab to view, create, edit, and delete aliases for variables or variable groups.

How to Get to This Tab

From the Macros/Variables/Aliases Dialog Box, click the Aliases tab.

Related Topics

•Aliases

•Working with Aliases

Field Reference

Table 11-20 Aliases Tab

Element

Description

New button

Click this button to create a new alias for variables or for variable groups.

Edit button

Select an alias and click this button to edit the alias.

Delete button

Select an alias and click this button to delete the alias.

Left pane

List of variable and variable group aliases. The letter "a" designates a variable alias. The letter "a" with a box designates a variable group alias.

Alias Contents

Contains the following:

•Description—Word or phrase describing the variable or variable group alias.

•List of variables or variable groups. Each entry contains information that identifies the variable or variable group, such as the logical element, element (if present), variable group, and so on.

Alias Dialog Box

Use the Alias dialog box to define aliases for variables or variable groups.

How to Get to This Tab

From the Aliases Tab, click the New button or select an existing alias and click the Edit button.

Related Topics

•Aliases

•Working with Aliases

Field Reference

Table 11-21 Aliases Dialog Box

Element

Description

Name

Name of the alias.

Description

Word or phrase that describes the alias.

Set Primary Variable button

After defining variables or variable groups for the alias, select one of the variables or variable groups and click this button. The selected variable or variable group becomes the primary variable.

In this way, only the primary variable or variable group is shown when designing service networks, and only the values for the primary variable or variable group need to be entered. The values are then propagated to all other variables or variable groups within the alias.

Alias Contents

Variables belonging to the selected alias.

Variables

Lists all variables and variable groups in the template:

•Name—Names of variables, variable groups defined in the template. Displayed as a hierarchical tree to show relationships between items.

•Description—Word or phrase describing the item.

•Type—Type of variable, as follows:

–Boolean—True or False.

–Date—Date in the format YY-MM-DD.

–Double—Double precision number, which can be defined as an integer, fixed-point number, or floating-point number.

–Float—Floating point number.

–IPAddrResourceType—IP address.

–Integer—Integer. You can define variable value restrictions that define minimum and maximum values or enumerate specific values.

–Long—Long integer.

–String—Sequence of simple objects. You can define variable value restrictions that define regular expressions or the enumerated values.

–Vlan—Name or number of VLANs discovered or created by VFrame.

•IsShared—Indicates whether the variable value can be used by child elements, if any exist, such as servers in a server group. True means the variable can be shared, and False means the variable cannot be shared.

•Multivalued—Indicates whether the variable is set to multivalue. True means the variable is set to multivalue, and False means it is not set to multivalue.

If a variable is set to multivalue, you must assign resource pools, not single values, as the value. For more information, see Understanding Variable and Variable Group Types.

•Optional—Indicates that a value is not required for the variable.

•Default/Fixed Value—Value assigned to the variable, if present.

Add button

Click this button to add the variable or variable group selected in the Variables or Typed Variable Groups field to the alias selected in the Name field.

Remove button

Click this button to remove the variable or variable group selected in the Alias Contents field from the selected alias.

Edit Macro Assignment Dialog Box

Use this dialog box to assign macros to targets and events.

How to Get to This Tab

Do one of the following:

•From the Macro Assignments Tab click the Associate macro button.

•For service network templates, from the Macro Map Tab, right-click an event and select Associate macro.

Related Topics

•Macros

•Creating Macro Assignments

•Deleting Macro Assignments

Field Reference

Table 11-22 Edit Macro Assignment Dialog Box

Element

Description

Logical Element

Name of the selected logical element.

Target Device Type

Target to which the macro is assigned.

Event

Event that triggers the macro to run.

Available Macros

List of macros that have been created or imported for the selected logical element.

Import Macros button

Click this button to import macros that were created outside of VFrame or that were created from another VFrame server and exported.

Note Once you select the desired macro, you can click the Show Details button to open the Edit Macro dialog box and view the macro. For more details, see Edit Macro Dialog Box.

Create Macros button

Select a macro file container and click this button to create a macro. For more information, see Edit Macro Dialog Box.

Edit button

Do one of the following:

•Select a macro file container and click this button to edit the macro file container. Change the name, description, or author of the macro file container in the appropriate fields and click OK.

•Select a macro and click this button to edit the macro. For more information, see Edit Macro Dialog Box.

Show Matching Macros check box

Select this check box to filter the list of macros to be only those that support the selected target type.

Supported Targets Tab

Use the Supported Targets tab to display and define constraint types and values (resource types and values) for the selected logical element.

How to Get to This Tab

From the Templates Tab, create a new template or open an existing template, click a logical element, and then click the Supported Targets tab.

Related Topics

•Targets

•Changing Targets

Field Reference

Table 11-23 Configure Tab

Element

Description

Element Name

Name of the logical element.

Show macro nodes

Click this check box to hide or display macro mappings.

Actions button

Select an item and click this button to open a context-sensitive drop-down menu of actions that you can perform. This menu is also available when you right-click an item.

Mappings

A hierarchical view of constraint types and values (resource types and values), targets, macros, and triggers for the selected logical element.

You can add, changes, or delete constraint types and values by selecting an item and clicking Actions or by right-clicking an item and selecting an option from the menu.

Template Validation Results Dialog Box

Use the Template Validation Results dialog box to check that you created all the necessary variables for your template.

When validating a template, VFrame checks the following:

•External references in macros can be resolved.

•Variable groups have at least one variable.

•Variables are aliased and shared properly.

•Logical elements have at least one link.

•Network start and network stop events have macros assigned.

•Every logical element has corresponding event pairs. For example, if there is a Deploy Network event, then there should be a corresponding Undeploy Network event. Event pairs are Deploy Network/Undeploy Network, Start Server/Stop Server, Start Server Group/Stop Server Group, Enter Maintenance/Exit Maintenance.

•All devices (such as CSM and firewall modules) have known system actions.

•All variable group types exist.

•No event loops exist.

•New variables have been aliased (applies only when validating a template in the IncrementalDesigning state).

•All aliases have at least two variables, and the primary variable is set.

Any assignments that cannot be resolved are identified so that you can return to the template and correct them.

How to Get to This Dialog Box

•From the Templates Tab, create a new template or open an existing template.

•Make the necessary changes, and then click Validate.

Note A template must be in the Designing state for the Validate button to be active. If you open a template that was verified or published, the Validate button is inactive, and you must change the template to activate it.

Related Topics

•Validating Service Network Templates

Field Reference

Table 11-24 Template Validation Results Dialog Box

Element

Description

Macro Resolution

External references in macros could not be resolved.

Variable Group Types

Variable groups do not have at least one variable.

Variables

Variables are not shared properly. Errors could indicate the following:

•Variables defined on logical elements (except HA and server group logical elements) or any of their endpoints must be shared. The exception to this rule is if the variables are aliased with non-shared variables on HA or server group logical elements or any of their endpoints.

•Primitive, non-shared variables cannot be defined on a server group or HA logical element.

•Macros that reference a variable that is part of an alias or alias group with non-shared variables must be associated to an event attached to a server group or HA logical element. The exception to this rule is if the macro is assigned to a server group or HA logical element and the referenced variable is not shared.

Unaliased New Variables

(Displayed only when validating a template in the IncrementalDesigning state.) New variables do not have a corresponding alias.

Links

Logical elements do not have at least one link.

Start/Stop Events

Network start or network stop events do not have macros assigned.

Empty Variable Groups

A variable group type does not exist.

Event Loops

Event loops exist.

Aliases

Indicates the following possible errors:

•Aliases do not have at least two variables. Although VFrame checks to make sure that you create only aliases that have at least two variables, you can delete one of these variables after creating the alias, leaving the alias with only one variable.

•The primary variable in an alias is in an unused macro. Primary variables must be in used macros because only variables in used macros are displayed during service network design.

•A nonshared alias variable is aliasing more than one nonshared variable that is defined on a server group or HA logical element.

Warning

Template contains macros that are not in use. Errors in this category do not prevent you from saving and publishing the template.

Storage Managers Tab

Use the Storage Managers tab to create storage templates and to define storage managers. Depending on whether you select a storage template or storage manager from the Storage Manager Templates selector, different tabs appear. All tab are described in Storage Managers Tab.

How to Get to This Tab

Select Design > Storage Managers to open the Storage Managers tab.

Related Topics

•Understanding Storage Manager Templates

•Working with Storage Manager Templates and Storage Managers

Field Reference

Table 11-25 Storage Managers Tab

Element

Description

Storage Manger Template (selected)

New button

Do one of the following:

•Select Storage Manager Templates from the Storage Manager Templates selector and click this button to create a new template. The Storage Manager dialog box opens so that you can define a name and description for your template.

•Select a storage manager template from the Storage Manager Templates selector and click this button to create a storage manager. The Storage Manager dialog box opens. For more details, see Storage Manager Dialog Box.

Edit button

Click this button to edit the selected storage manager template or storage manager.

Delete button

Click this button to delete the open and selected template or storage manager.

Note You can only delete a template if there are no storage managers associated with it.

Save button

Click this button to save changes made to the open and selected storage manager.

Clone button

Click this button to duplicate the selected template and assign it a different name.

Import button

Click this button to import a template that has already been created. Make sure that the VFrame version that you created the template in matches the VFrame version that you are importing to. These versions must match for the import to be successful.

Export button

Click this button to export a saved template so that it can be imported into another virtual context or VFrame.

Storage Manager Templates selector

Lists the storage manager templates and storage managers that have been created. Click the name of a template or storage manager to open the definition pane for it.

Macro Assignments tab

Enables you to assign macros to targets and events. Also allows you to create or import macro file containers and define variables, variable groups, and aliases. For detailed reference information, see Macro Assignments Tab.

Storage Manager (selected)

Variables tab

Enables you to define the variable values for storage managers within your service network. For detailed reference information, see Variables Tab (Storage Managers).

Storage Manager Dialog Box

If you choose to manage storage arrays through storage managers, you must define information about the storage managers you want to use.

How to Get to This Tab

From the Storage Managers Tab, select a template and click New.

Related Topics

•Configuring Storage Manager Credentials, page 4-13

•Understanding Storage Manager Templates

•Working with Storage Manager Templates and Storage Managers

Field Reference

Table 11-26 Storage Manager Dialog Box

Element

Description

Name

Name of the storage manager.

IP address

IP address of the storage manager.

If you have high availability (HA) set up, this is the IP address of the primary storage manager. VFrame first contacts the storage manager at this IP address to manage associated storage devices. If this storage manager is unavailable, VFrame contacts the storage manager at the secondary IP address.

Port

SSH port of the storage manager.

Secondary IP address

IP address of the secondary storage manager. If you have HA set up and the primary storage manager is unavailable, VFrame contacts the storage manager at this IP address.

Secondary Port

SSH port of the secondary storage manager.

Path

Path where the storage manager application is located.

Variables Tab (Storage Managers)

When the associated template was created, variables were defined. Use this tab to define the values for these variables as they pertain to the storage managers within your service network.

How to Get to This Tab

From the Storage Managers Tab, create a new storage template or open an existing storage template, and then click New.

Related Topics

•Understanding Storage Manager Templates

•Working with Storage Manager Templates and Storage Managers

Field Reference

For each variable, the following information is displayed:

•Variable Group Name

•Variable Name

•Variable Value

•Description

The variable value is a blank field. For each variable, enter the appropriate value into the variable value field that corresponds to your storage manager.

LOM Managers Tab

Use the LOM Managers tab to create LOM manager templates and define LOM managers.

How to Get to This Tab

Select Design > LOM Managers to open the LOM Managers tab.

Related Topics

•Understanding LOM Manager Templates

•Working with LOM Manager Templates

Field Reference

Table 11-27 LOM Managers Tab

Element

Description

LOM Manager Template (selected)

New button

Select LOM Manager Templates from the LOM Manager Templates selector and click this button to create a new LOM manager template. The LOM Manager Template dialog box opens so that you can define a name and description for the LOM manager template that you are creating.

Edit button

Click this button to edit the selected LOM manager template or LOM manager.

Delete button

Click this button to delete the open and selected LOM manager template or LOM manager.

Save button

Click this button to saves changes made to the open and selected LOM manager.

Clone button

Click this button to duplicate the selected template and assign it a different name.

Import button

Click this button to import a template that has already been created. Make sure that the VFrame version that you created the template in matches the VFrame version that you are importing to. These versions must match for the import to be successful.

Export button

Click this button to export a saved template so that it can be imported into another virtual context or VFrame.

LOM Manager Templates selector

Lists the LOM manager templates and LOM managers that have been created. Click the name of a template or LOM manager to open the definition pane for it.

Macro Assignments tab

Enables you to assign macros to targets and events. Also allows you to create or import macro file containers and define variables, variable groups, and aliases. For detailed reference information, see Macro Assignments Tab.

Storage Manager (selected)

Variables tab

Enables you to define the variable values for LOM managers within your service network. For detailed reference information, see Variables Tab (LOM Managers).

Variables Tab (LOM Managers)

When the associated template was created, variables were defined. Use this tab to define the values for these variables as they pertain to the LOM managers within your service network.

How to Get to This Tab

From the LOM Managers Tab, create a new LOM template or open an existing LOM template, and then click New.

Related Topics

•LOM Managers Tab

•Understanding LOM Manager Templates

Field Reference

For each variable, the following information is displayed:

•Variable Group Name

•Variable Name

•Variable Value

•Description

The variable value is a blank field. For each variable, enter the appropriate value into the variable value field that corresponds to your LOM manager.

LOM Manager Dialog Box

After creating a LOM manager template, you must create your LOM Manager in VFrame. Doing so provides necessary information so that VFrame can discover the LOM interfaces associated with your LOM manager.

How to Get to This Tab

From the LOM Managers Tab, select a template and click New.

Related Topics

•Understanding LOM Manager Templates

•Working with LOM Manager Templates

Field Reference

Table 11-28 LOM Manager Dialog Box

Element

Description

Name

Name of the LOM manager.

IP address or Hostname

IP address or hostname of the primary LOM manager. VFrame first contacts the LOM manager at this IP address or hostname to manage associated servers. If this LOM manager is unavailable, VFrame contacts the LOM manager at the secondary IP address or hostname.

Port

Primary SSH port on which the LOM manager accepts incoming requests. VFrame first contacts the primary LOM manager using this SSH port. If the primary LOM manager is unavailable, VFrame contacts the secondary LOM manager using its IP address or hostname and this SSH port.

Secondary IP address or Hostname

IP address or hostname of the secondary LOM manager. If the primary LOM manager is unavailable, VFrame contacts the LOM manager at this IP address or hostname.

Secondary Port

Secondary SSH port on which LOM manager accepts incoming requests. If the primary LOM manager is unavailable, VFrame contacts the secondary LOM manager using its IP address or hostname and this SSH port.