-
VFrame Data Center Administration Guide, Version 1.2
-
Preface
-
Getting Started with VFrame Data Center
-
Managing Roles and Local Users
-
Setting Up the Physical Network
-
Managing Device Credentials
-
Configuring DHCP for VFrame
-
Discovering Devices
-
Managing Devices
-
Managing Server Images
-
Managing Resource Pools
-
Managing Virtual Contexts
-
Designing Templates
-
Managing the Global Library
-
Designing Service Networks
-
Operating Service Networks
-
Managing Faults
-
Viewing Reports
-
Maintaining Devices
-
Managing the VFrame System
-
System Actions and Default Variables
-
Writing Macros for Use in Templates
-
Index
-
Table Of Contents
Understanding Basic Template Components
Working with Basic Template Components
Creating Service Network Templates—Basic Workflow
Understanding Service Network Templates
Service Network Template Logical Elements
Service Network Template Design and Network Virtualization
Service Network Template States
Service Network Template Change Control
Creating a Service Network Template—Scenario
Identify Variables and Variable Groups
Create Variables and Variable Groups
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
Importing Service Network Templates
Exporting Service Network Templates
Troubleshooting Service Network Template Design
Creating Storage Manager Templates and Storage Managers—Basic Workflow
Understanding Storage Manager Templates
Default Storage Manager Templates
User-Defined Storage Manager Templates
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
Creating LOM Manager Templates and LOM Managers—Basic Workflow
Understanding 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
Troubleshooting LOM Manager Templates
Macros/Variables/Aliases Dialog Box
Edit Macro Assignment Dialog Box
Template Validation Results Dialog Box
Variable Values Tab (Storage Managers)
Variable Values Tab (LOM Managers)
Designing Templates
VFrame Data Center 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.
This chapter provides detailed information about templates, and includes the following sections:
•
Working with Service Network 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.
This section provides detailed information about basic template components and concepts, and includes the following topics:
•
•
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 template basic event flow helps you understand the components that you need to create 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, and load balancers) 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
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. This section describes these basic components, and includes the following topics:
Logical Server Groups
In VFrame Data Center, there are a number of ways to design logical server groups. The following is a list of guidelines you can use when designing server groups:
•
•
Logical Elements and 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 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 one or more constraint types, and either no targets, or one or more targets, as shown in Table 11-1. For example, a constraint type might be FirewallType and its value Firewall Services Module Router Mode.
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 cases:
•
•
•
Note
Events
Events are operations performed by the service network. VFrame provides a set of pre-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 Events
Following are the service network template events:
•
–
–
–
•
–
–
–
–
–
–
–
–
–
Storage Manager Template Events
Following are the storage manager template events:
•
•
•
LOM Manager Template Events
Following are the LOM manager template events:
•
•
•
•
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 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, or commands for other servers.
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.
Note
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 appropriate target device in your template. For more information about writing macros, see Appendix B, "Writing Macros for Use in Templates."
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 of the macro file container.
Figure 11-6 Example of Macro File Container
Macro Design Concepts
When designing macros, keep in mind the following considerations:
•
•
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, a CSM configuration macro linked to the Deploy Network event could contain the following commands:
serverfarm f1nat servetake it easy. byterno nat clientvserver vs1virtual 10.20.221.100serverfarm f1persistent rebalanceinserviceThe CSM unconfiguration macro linked to the Undeploy Network event must then be in the following order:
no serverfarm f1no vserver vs1If the unconfiguration 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 unconfiguration 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 httpport 80Later, service network B runs the following commands:
probe theProbe httpport 443The last started service network overwrites the previously started service network. Port 80 is overwritten with port 443. 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. 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, if a device CLI prompt is "prompt#", and the configuration macro runs the following subroutine:
config("interface vlan230nameif 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() subroutine 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, if the following sequence is run:
@exceptions = ("INFO: Security level for \".*\" set to .* by default.");set_config_check(@exceptions);config("interface vlan230nameif outside");The config() subroutine runs successfully even if the "INFO: Security level for \".*\" set to .* by default." message appears.
You can also run the following example 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, run the following example:
@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, page 14-19.
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 Logical Elements 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 Variables On the Variables Tab, page 12-7.
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.
This section describes the specific steps for working with template components, and includes the following topics:
The sections describing the specific steps for creating and managing each type of template are also in this chapter, and they include the following topics:
•
•
•
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 by performing the following steps.
Procedure
Step 1
Step 2
Step 3
Step 4
The Supported Targets dialog box appears.
Step 5
Step 6
Step 7
Related Topics
Working with Events
When working with service network templates, you can add events to an event folder, edit events, view events, delete events, and order events. 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.
This section describes working with events, and includes the following topics:
Adding Events
You can add events to event folders.
Procedure
Step 1
Step 2
Step 3
The event folders and events appear.
Step 4
Step 5
The Event Dialog dialog box appears.
Step 6
Step 7
After adding an event, you need to assign a macro to it. See Creating Macro Assignments.
Related Topics
Editing/Viewing Events
You can edit and view events for logical elements in your service network template. However, you cannot create events.
Procedure
Step 1
Step 2
Step 3
The event folders and events appear.
Step 4
Step 5
Step 6
Step 7
Step 8
Tips
You can also access the Event dialog box on the Macro Map tab. To add an event, right-click the map area and click Add event. To edit an event, right-click the appropriate event and click Edit Event.
Related Topics
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
Step 2
Step 3
The event folders and events appear.
Step 4
Step 5
Related Topics
Ordering Events
For service network templates, you can change the order in which events and macros are executed.
Procedure
Step 1
Step 2
Step 3
The event folders and events appear.
Step 4
Step 5
The Event Ordering dialog box appears.
Step 6
Note
Step 7
Tips
You can also access the Event Ordering dialog box on the Macro Map tab. On the Macro Map Tab, right-click the appropriate event and click Change Ordering.
Related Topics
Working with Macros
This section helps you perform tasks related to macro file containers, and includes the following topics:
•
•
•
•
This section also help you perform tasks related to macros, and includes the following topics:
•
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
Step 2
Step 3
•
•
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Note
Step 4
•
•
Note
Step 5
Related Topics
Importing Macro File Containers
You can import macro file containers that you created outside VFrame or on another VFrame server.
Procedure
Step 1
Step 2
Step 3
•
•
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 4
Step 5
Step 6
Step 7
Step 8
Tips
For service network templates only, you can also access the Macro Assignment tab on the Macro Map tab. On the Macro Map tab, right-click an event and then click Associate Macro.
Related Topics
Exporting Macro File Containers
You can export macro file containers that you created in VFrame.
Procedure
Step 1
Step 2
Step 3
•
•
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 4
Step 5
Step 6
Step 7
Step 8
Related Topics
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
Step 2
Step 3
•
•
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 4
Step 5
Step 6
Tips
For service network templates, you can also delete a macro file container by right-clicking the container and clicking Delete Macro File Container.
Related Topics
Creating, Editing and Viewing Macros
You can create macros to use in templates.
Before You Begin
•
•
Procedure
Step 1
Step 2
Step 3
•
•
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 4
•
•
Step 5
Step 6
Tips
For service network templates, you can also access the Edit Macro dialog box in the Macro Map tab. In the Macro Map Tab, right-click the appropriate macro and click Edit/View Macros or right-click the appropriate event, click Associate macro, and then click the New Macro or Edit.
Related Topics
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
Step 2
Step 3
•
•
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 4
Step 5
Tips
You can also click the appropriate macro, right-click it and then click Edit.
Related Topics
Creating Macro Assignments
For a macro to be executed on a particular target, you need to associate the macro with the target. You can also define the order in which macros are run when the associated event occurs.
Procedure
Step 1
Step 2
Step 3
Step 4
The Edit Macro Assignment dialog box appears.
Step 5
•
•
Step 6
Tips
For service network templates, you can also access the Edit Macro Assignment dialog box in the Macro Map tab. In the Macro Map tab, right-click the appropriate event and click Associate macro.
Related Topics
•
Deleting Macro Assignments
If you no longer want a macro associated with an event, you can disassociate it.
Procedure
Step 1
Step 2
Step 3
Step 4
The Edit Macro Assignment dialog box appears.
Step 5
Step 6
Step 7
Tips
For service network templates, you can also access the Edit Macro Assignment dialog box on the Macro Map tab. On the Macro Map Tab, right-click the appropriate event and click Associate macro.
Related Topics
Ordering Macro Execution
For service network templates, you can change the order in which macros are run.
Note
Procedure
Step 1
Step 2
Step 3
Step 4
The Event Ordering dialog box appears.
Step 5
Step 6
Tips
You can also access the Event Ordering dialog box on the Events tab. On the Events Tab, right-click the appropriate event and click Change Ordering.
Related Topics
Working with Variables
This section helps you work with variables while creating or modifying templates, and includes the following topics:
•
•
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
Step 2
Step 3
Step 4
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 5
Step 6
Step 7
•
•
•
Step 8
Tips
For service network templates, you can also access the Variables tab on the Properties tab. On the Properties Tab, click Macros & Variables and then click the Variables tab.
Related Topics
•
Creating, Editing, and Deleting Variables
You can create, edit, and delete variables while creating or modifying templates.
Note
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
Step 2
Step 3
Step 4
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 5
Step 6
Step 7
•
•
•
Step 8
Tips
For service network templates, you can also access the Variables tab on the Properties tab. On the Properties Tab, click Macros & Variables and then click the Variables tab.
Related Topics
•
Working with Aliases
This section helps you work with aliases, and includes the following topics:
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.
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
Step 2
Step 3
Step 4
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 5
Step 6
•
•
•
•
Note
Step 7
Note
Step 8
Tips
For service network templates, you can also access the Aliases tab on the Properties tab. On the Properties Tab, click Macros & Variables and then click the Aliases tab.
Related Topics
Deleting Aliases
When a variable or variable group alias is no longer needed, you can delete it.
Procedure
Step 1
Step 2
Step 3
Step 4
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 5
Step 6
Step 7
Tips
For service network templates, you can also access the Aliases tab on the Properties tab. On the Properties Tab, click Macros & Variables and then click the Aliases tab.
Related Topics
Service Network Templates
This section provides detailed information about service network templates, and includes the following topics:
•
•
•
•
•
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
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:
•
•
•
•
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 firewalls, 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.
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 additional components. This section describes the additional template components, and includes the following topics:
•
•
•
•
Service Network Template Logical 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 add a logical element or endpoint to your service network template, events, system actions and default variables are also added. The system actions perform functions that are required for basic operation of your network. For more information, see Appendix A, "System Actions, Default Variables, and Resource Attribute Variables."
You can also create user macros and assign them to the logical elements and endpoints. See Table 11-1 for a description of these logical elements and endpoints.
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. Three examples follow that represent CSM and ESX service network templates.
Example 1
In the following 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.
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
Example 3
In the following example, an ESX template is used to deploy a set of ESX servers in a VMware cluster.
Figure 11-11 ESX Service Network Template
vSwitch0 is an ESX virtual switch. vSwitch0 is connected to the 802.1q trunk. Because vSwitch0 is connected to the trunk, the Layer 2 ports connected to vSwitch0 will automatically be configured in trunk mode.
vSwitch1 is an ESX virtual switch. vSwitch1 is connected to VLAN VM2. Because vSwitch1 is directly connected to a VLAN, the Layer 2 ports will automatically be configured in access mode.
Each ESX server in the server group is added to VMware VirtualCenter when the system is first booted. All ESX servers have access to the SAN storage with VMFS volumes and to the NFS shared storage.
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-3 lists and describes all of the possible states.
Table 11-3 Template States
Designing
Template is being created or modified and has not yet been verified. Does not indicate whether the template has been saved.
Validated
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:
•
•
•
•
•
•
•
Note
These are the changes that you are not allowed to make:
•
•
•
•
•
•
•
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 Validate and correcting 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.
Creating a Service Network Template—Scenario
In the scenario shown in Figure 11-12., 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.
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-13). You do this by using variables and variable groups in macros.
This section describes how to create the service network template, and includes the following topics:
•
•
•
•
•
Tip
Figure 11-12 Sample Service Network Topology
Figure 11-13 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, VLAN, a group of servers, NAS storage, and a load balancer connected in single subnet (bridge) mode (see Figure 11-12).
Procedure
Step 1
Step 2
The Input dialog box appears.
Step 3
For this scenario, enter csmTemplate as the name.
The template name appears on the tab of the upper right selector, and just below the Macro Map tab.
Step 4
•
•
•
•
•
Note
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 Chapter 13, "Designing Service Networks." For a complete list of system actions and default variables by logical element, see Appendix A, "System Actions, Default Variables, and Resource Attribute Variables."
Step 5
Step 6
Step 7
Step 8
Your template, shown in Figure 11-14, now looks similar to the network diagram shown in Figure 11-12.
Figure 11-14 csmTemplate
Note
Related Topics
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.
cat(config)#module csm 3cat(config-module-csm)#2.
cat(config-module-csm)#vlan 100 clientcat(config-slb-vlan-client)#ip address 10.11.100.2 255.255.255.192cat(config-slb-vlan-client)#gateway 10.11.100.1cat(config-slb-vlan-client)#3.
cat(config-module-csm)#vlan 200 servercat(config-slb-vlan-server)#ip address 10.11.100.2 255.255.255.1924.
cat(config-module-csm)#serverfarm wwwfarmcat(config-slb-sfarm)#real 10.11.100.4cat(config-slb-real)#inservicecat(config-slb-real)#real 10.11.100.5cat(config-slb-real)#inservice5.
cat(config-module-csm)#vserver VS1cat(config-slb-vserver)#virtual 10.11.100.241 anycat(config-slb-vserver)#serverfarm SF1cat(config-slb-vserver)#inserviceIdentify Variables and Variable Groups
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
1.
cat(config)#module csm 3cat(config-module-csm)#2.
cat(config-module-csm)#vlan $ClientVlanID $ClientVlanTypecat(config-slb-vlan-client)#ip address $ClientVlanIP->{IPAddress}cat(config-slb-vlan-client)#gateway $ClientVlanGtw->{IPAddress}3.
cat(config-module-csm)#vlan $ServerVlanID $ServerVlanTypecat(config-slb-vlan-server)#ip address $ServerVlanIP->{IPAddress}4.
cat(config-module-csm)#serverfarm $ServerFarmNamecat(config-slb-sfarm)#real $RealServerIP->{IPAddress}cat(config-slb-real)#inservice5.
cat(config-module-csm)#vserver $VServerNamecat(config-slb-vserver)#virtual $VServerIP->{IPAddress} anycat(config-slb-vserver)#serverfarm $VServerNamecat(config-slb-vserver)#inserviceA compiled list of these variables is listed in Table 11-4. Note that related variables are grouped.
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 Global Libraries and Variables, page 12-1.
Procedure
Step 1
Step 2
Step 3
Step 4
a.
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Note
b.
c.
d.
Step 5
a.
b.
The Variable dialog box appears.
c.
–
–
–
–
–
–
d.
Note
Step 6
a.
b.
The Variable Group dialog box appears.
c.
–
–
–
–
–
The Variable Group Type Selector dialog box appears.
–
–
d.
e.
f.
The Variable Group dialog box appears.
g.
–
–
–
–
–
The Variable Group Type Selector dialog box appears.
–
–
h.
i.
The Variable Group dialog box appears.
j.
–
–
–
–
–
The Variable Group Type Selector dialog box appears.
–
–
For more information about variable group types in general, see Understanding Global Libraries and Variables, page 12-1.
Figure 11-15 shows the Variables tab listing the new variables and variable groups.
Figure 11-15 csmTemplate Variables
Related Topics
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-5 use the same values, so you can create aliases for them.
Procedure
Step 1
Step 2
Step 3
Step 4
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 5
Step 6
a.
b.
–
–
c.
–
–
–
–
d.
Step 7
Figure 11-16 CcsmTemplate Aliases
Related Topics
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.
You will create a macro to configure the CSM and another macro to delete the CSM configuration. Then, you will associate these macros with the Deploy and Undeploy Network event. You will create a macro to add the real server and another macro to delete the real server. Then, you will associate these macros with the Start Server and Stop Server events.
This macro uses the VFrame Data Center 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
Step 2
Step 3
Step 4
The Macros/Variables/Aliases dialog box appears with the Macros tab selected.
Step 5
The Edit Macro dialog box appears.
Step 6
•
•
•
•
•
# Config csm server vlansub config_server_vlan {config ("vlan $ServerVlanID $ServerVlanTypeip address ${\&get_ip($ServerVlanIP->{IPAddress}, INFO)} ${\&get_mask($ServerVl anIP->{IPAddress})}");}# Config csm client vlansub config_client_vlan {config ("vlan $ClientVlanID $ClientVlanTypeip address ${\&get_ip($ClientVlanIP->{IPAddress}, INFO)} ${\&get_mask($ClientVl anIP->{IPAddress})}gateway ${\&get_ip($ClientVlanGtw->{IPAddress}, INFO)}");}# Config csm serverfarm(s) & probesub config_serverfarm {config ("serverfarm $ServerFarmName");}# config csm vserver servicesub config_vserver {config ("vserver $VServerNamevirtual ${\&get_ip($VServerIP->{IPAddress}, INFO)} anyserverfarm $ServerFarmNameinservice");}sub config_csm {config_server_vlan;config_client_vlan;config_serverfarm;config_vserver;}Step 7
Step 8
The Edit Macro dialog box appears.
Step 9
•
•
•
•
•
sub add_realserver {config ("serverfarm $ServerFarmNamereal ${\&get_ip($RealServerIP->{IPAddress}, INFO)}inservice");}Step 10
Step 11
my @exceptions = {".* "};sub remove_real_server {set_config_check(@exceptions);config ("serverfarm $ServerFarm->{Name}no real ${\&get_ip($RealServerIp->{IPAddress}, INFO)}");}Step 12
my @exceptions = (".*");sub unconfig_csm;sub unconfig_serverfarm;sub unconfig_interfaces;sub unconfig_probe_ping;sub unconfig_vserver;sub unconfig_csm {set_config_check(@exceptions);unconfig_vserver;unconfig_serverfarm;unconfig_probe_ping;unconfig_interfaces;}sub unconfig_interfaces {config ("no vlan $ClientInterfaceVariableType->{Vlan} $ServerInterfaceVariableType->{InterfaceType}no vlan $ServerInterfaceVariableType->{Vlan} $ServerInterfaceVariableType->{InterfaceType}");}sub unconfig_serverfarm {config ("no serverfarm $ServerFarm->{Name}");}sub unconfig_probe_ping {config ("no probe PING icmp");}sub unconfig_vserver {config ("no vserver $Vserver->{Name}");}Related Topics
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
Step 2
Step 3
Step 4
The Edit Macro Assignment dialog box appears.
Step 5
Step 6
Step 7
Step 8
Step 9
Related Topics
Validate Your Service Network Template
You are ready to validate your service network template after you have done the following:
•
•
•
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
Step 2
Step 3
The Template Validation Results dialog box appears. In this case, your service network template has no errors, as shown in Figure 11-17.
Figure 11-17 Validation Results Dialog Box
Related Topics
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
Step 2
Step 3
Step 4
In the Service Templates selector, the status of your service network is updated to Published, as shown in Figure 11-18.
Step 5
Figure 11-18 csmTemplate Published
Related Topics
Working with Service Network Templates
This section helps you work with service network templates, and includes the following topics:
•
•
•
•
•
•
•
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 firewalls, switches, load balancers, 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
•
•
Procedure
Step 1
Step 2
•
•
When the template appears, you see four panes. The upper left selector is labeled Service Templates. The lower left selector has no label, and it shows all the logical elements in the template. The upper right selector is labeled with the name of the template, and it shows the logical elements and how they are connected. If the template is a new template, no logical elements are seen. The lower right selector contains three tabs, Macro Map, Properties and Events. The selector also contains a map of all the events, system actions, and macros in the template. If the template is a new template, the Deploy Network, Undeploy Network and Verify Network events appear, along with the create-vlans, cleanup-vlans and verify-vlans system actions.
Step 3
Step 4
Step 5
a.
b.
The Type dialog box appears.
c.
d.
The Type dialog box appears.
e.
f.
–
–
–
g.
–
–
At this point, when you expand the server group, you will see one ESX virtual switch and one port group. If you want to create another ESX virtual switch, draw another connection between the VLAN and the server group. You create multiple ESX virtual switches within a server group by drawing multiple connections between the VLAN and the server group. If you want to create another port group under an existing ESX virtual switch, draw a connection between the VLAN and the ESX virtual switch. You create multiple port groups under one ESX virtual switch by drawing multiple connections between the VLAN and the ESX virtual switch.
h.
When you connect more than one VLAN to the trunk, you can specify which VLAN is the native VLAN. Right-click the logical element and click on Set Native VLAN. Click any of the VLANs you see in the menu that appears to designate that VLAN as the native VLAN.
The PXE request sent by a physical server at boot time is always untagged. The server does not add a VLAN tag to the PXE request. This is because the PXE request is generated by the BIOS, which is not aware of the trunk configuration.
When an Layer 2 port is configured in trunk mode, untagged frames are forwarded to the native VLAN. If there is no native VLAN configured on the trunk, untagged frames are dropped. PXE requests would be dropped by the Layer 2 port if there was no native VLAN configured on the Layer 2 port. That means a native VLAN must always be configured on a trunk port associated with the PXE interface.
Step 6
•
Note
•
•
Step 7
•
For details, see Working with Macros, Working with Variables, and Working with Aliases.
•
•
Note
Step 8
If no errors are encountered during the validation, you can publish your template. Proceed to Step 10. 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 9.
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 9
Note
Step 10
Related Topics
•
•
Validating Service Network Templates
Before you can publish a template and use it to create service networks, you must validate it.
Note
Procedure
Step 1
Step 2
Step 3
If errors are found, they must be corrected before you can save and publish the template.
Related Topics
•
•
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
•
Procedure
Step 1
Step 2
Step 3
•
•
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 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
•
•
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
Step 2
Step 3
Related Topics
•
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
Step 2
Step 3
Step 4
Related Topics
•
Importing Service Network Templates
You can share service network templates with other VFrame servers and other contexts. To share, you can import templates to the appropriate VFrame server or context.
Before You Begin
Ensure that all new variables are aliased.
Procedure
Step 1
Step 2
Step 3
The Import Template dialog box appears.
Step 4
Step 5
a.
b.
c.
d.
e.
Step 6
a.
b.
c.
d.
e.
f.
g.
h.
The Import dialog box appears.
i.
j.
Note
Related Topics
•
Exporting Service Network Templates
You can share service network templates with other VFrame servers and other contexts. To share, you can export templates from the appropriate VFrame server or context.
Before You Begin
Ensure that the template has been validated. Only validated templates can be exported.
Procedure
Step 1
Step 2
Step 3
The Export Template dialog box appears.
Step 4
Step 5
a.
The Export dialog box appears.
b.
c.
Step 6
a.
b.
c.
d.
e.
f.
g.
The Export dialog box appears.
h.
i.
Related Topics
•
Troubleshooting Service Network Template Design
This section describes some problems you might encounter when working with service network templates and their solutions, and includes the following topics:
•
•
Problem
Solution
Problem
Solution
Problem
Solution
Problem
Solution
Problem
Solution
Problem
Solution
Problem
Solution
Problem
Solution
Problem
Solution
•
•
Storage Manager Templates
This section provides detailed information about storage manager templates, and includes the following topics:
•
•
•
Creating Storage Manager Templates and Storage Managers—Basic Workflow
Table 11-6 is an overview of the steps you take to create a storage manager template and storage manager in VFrame.
Table 11-6 Creating Storage Manager Templates and Storage Managers—Basic Workflow
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:
•
•
•
•
Step 2
Save your storage manager template.
Step 3
Define your storage manager (see Defining Storage Managers).
Understanding Storage Manager Templates
Storage templates and Storage Manager definitions together provide VFrame with the necessary information to discover storage arrays and perform LUN masking and unmasking on them.
This section helps you understand these concepts, and includes the following topics:
•
•
Default Storage Manager Templates
The following default storage templates perform LUN masking, LUN unmasking, and storage inventory retrieval:
•
•
•
To obtain more information about the default storage templates, choose Tools > Storage Managers and click one of the default templates in the Storage Manager Templates selector. The Macro Assignments tab appears showing the macros with their associated targets and events, contained in the template.
Tip
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:
•
•
•
You then associate these macros with related events, such as discovery (Inventory event), masking LUNs (Mask LUN event), and unmasking LUNs (Unmask LUN event). 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.)
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
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 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
This section helps you work with storage templates, and includes the following topics:
•
•
•
•
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
•
•
•
Procedure
Step 1
Step 2
•
•
Step 3
•
•
Step 4
Step 5
Step 6
Related Topics
•
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
Step 2
Step 3
Related Topics
•
•
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
Step 2
Step 3
Step 4
Step 5
Related Topics
•
•
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 to the appropriate VFrame server or context.
Procedure
Step 1
Step 2
•
•
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
•
•
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
Step 2
Step 3
Step 4
a.
b.
c.
d.
Step 5
You can now discover your storage managers. See Discovering Storage Devices, page 6-6.
Related Topics
•
•
LOM Manager Templates
This section provides detailed information about LOM manager templates, and includes the following topics:
•
•
•
•
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-7 Creating LOM Manager Templates and LOM Managers—Basic Workflow
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:
•
•
•
•
Step 2
Save your storage template.
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, page 3-6.
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, page 3-19. For information about setting up a third-party client software and configuration on a Linux device, see Setting Up Independent LOM Managers, page 3-21.
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:
•
•
•
•
•
•
•
•
To obtain more information about the default LOM manager templates, choose Tools > LOM Managers and click one of the default templates in the LOM Manager Templates selector. The Macro Assignments tab appears showing the macros, with their associated targets and events.
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:
•
•
•
•
•
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
This section helps you work with LOM manager templates, and includes the following topics:
•
•
•
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. VFrame creates default internal LOM managers that are hosted on the VFrame itself that are needed for the automatic LOM discovery (see Automatic LOM Discovery, page 6-10).
Before You Begin
•
•
•
Procedure
Step 1
Step 2
•
•
Step 3
•
•
Step 4
Step 5
Step 6
Related Topics
•
Deleting LOM Manager Templates
If you no longer need a LOM manager template, you can delete it.
Note
Before You Begin
Make sure that the LOM manager template is no longer required.
Procedure
Step 1
Step 2
Step 3
Related Topics
•
•
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
Step 2
•
•
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
•
•
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
Step 2
Step 3
Step 4
Entering a value for the primary IP address is mandatory. 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, page 17-12.
VFrame-created LOM managers will have names starting with vfdclm_, which is a naming convention reserved for VFrame-created LOM managers; do not use this naming convention for user-defined LOM managers.
All VFrame-created LOM managers have the 127.0.0.1 (localhost) IP address, indicating that the LOM manager functionality is hosted on VFrame itself. You do not need an external host to function as a LOM manager in such cases.
Step 5
The new LOM manager appears in the LOM Manager Templates selector under the LOM logical element to which it is associated.
Step 6
If you decide to use the LOM inventory file, you can still work with the LOM inventory after you have configured the LOM manager by using the LOM Inventory dialog box. For more information, see Working with the LOM Inventory, page 6-12.
Note
Step 7
Step 8
Step 9
Related Topics
•
•
Troubleshooting LOM Manager Templates
This section describes some problems you might encounter when working with LOM Manager templates and their solutions, and includes the following topics:
•
•
•
Problem
Solution
•
•
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.
•
Problem
Solution
Problem
Solution
Template Design Reference
This section provides reference information, and includes the following topics:
Templates Tab
Use the Templates tab to create and manage service network templates.
How to Get to This TabChoose View > Templates to open the Templates tab.
Related Topics•
•
•
Field Reference
Table 11-8 Templates Tab
New button
Click this button to create a new template. The Input dialog box appears 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 Validate and correcting 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.
Service Templates selector
Lists any service network templates that have been created. Double-click a template to open the template in the lower left portion of the selector.
Template topology selector
Template topology tab—Shows the logical elements and links.
The lower right portion of the selector shows different tabs, depending on which parts of the template are selected in the lower left portion of the Service Templates selector.
Tools
Click a button to perform the appropriate action:
•
•
Click Select and then right-click the template topology work area to choose 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-14.
•
Click Zoom in rect 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.
•
•
•
•
Use the Page Layout tab to set up the page layout:
–
Check either the Portrait or Landscape check box.
–
Enter in inches the left, right, top and bottom margins.
–
Click either Letter, Legal, Invoice, Executive, A0 (ISO/DIN & JIS), A1 (ISO/DIN & JIS), A2 (ISO/DIN & JIS), or A3 (ISO/DIN & JIS).
Use the Header/Footer tab to set up headers and footers:
–
–
–
–
Use the Sheet tab to configure a sheet.
–
–
–
•
Elements in the template topology work area
Do one of the following to add links and logical elements to the service network template:
•
•
–
–
–
–
–
–
–
–
–
–
For a detailed description of these elements, see Service Network Template Logical Elements.
Lower right tabs
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
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
How to Get to This TabOn the Templates Tab, double-click a service network template.
Related TopicsField Reference
Table 11-9 Macro Map Tab
Element Name
Name of the selected service network template.
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.
•
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:
–
•
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:
–
–
•
You cannot view, edit, or delete system actions.
See Tools in Table 11-8 for information about the tools that display on the left hand side of the tab.
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 TabOn the Templates Tab, open a service network template, then click Properties.
Related TopicsField Reference
Table 11-10 Properties Tab
Element Name
Name of the selected service network template.
Description
Description of the template.
Macros & Variables button
Macro & Variables—Allows you to create macros, create or import macro file containers, and define variables, variable groups, and aliases. It also enables you to assign macros to events. For detailed reference information, see Macro Assignments Tab.
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 Editing/Viewing Events.
How to Get to This TabOn the Templates Tab, open a service network template, then click the Events tab.
Related TopicsField Reference
Table 11-11 Events Tab
Element Name
Name of the selected service network template.
Actions
Click an item and then click Actions to open a context-sensitive drop-down menu of actions that you can perform. This menu is also available when you right-click an folder or event.
Network or 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:
•
•
•
•
Event Dialog Box
Use the Event dialog box to create and edit events.
How to Get to This TabOn the Events Tab, right-click the appropriate event folder and then click Add Event, or right-click the desired event and then click Edit Event.
Related TopicsField Reference
Event Ordering Dialog Box
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 Dialog BoxDo one of the following:
•
•
Related TopicsField Reference
Macro Assignments Tab
Use the Macro Assignments tab to edit macros, edit targets, and 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 TabOn the Templates Tab, Storage Managers Dialog Box, or in the LOM Managers Dialog Box, create a new template or open an existing template, then click a logical element.
Related TopicsField Reference
Table 11-14 Macro Assignments Tab
Name
The name of the selected template.
Type
The type of template.
Native VLAN
The type of management VLAN. This option appears when the 802.1q Trunk logical element is selected.
Configure Native VLAN On This 802.1q Trunk
Check this check box to enable native VLAN on the 802.1q trunk.
Boot Storage Type
The storage type. This option appears when the Server Group logical element is selected.
Target
The target the macro is assigned to.
Event
The event that triggers the macro.
Macro
Name of the macro.
Description
Word or phrase that describes the macro.
Macros & Variables
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.
Edit Targets
Click this button to open the Supported Targets dialog box. In this dialog box, you can choose constraint types and supported targets. For detailed reference information, see Supported Targets Dialog Box.
Associate button
Click this button to create a macro assignment. For detailed reference information, see Edit Macro Assignment Dialog Box.
Dissociate button
Click a macro assignment and click Delete 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
•
How to Get to This Dialog BoxOn the Properties Tab or the Macro Assignments Tab click the Macros & Variables button.
Related TopicsField Reference
Table 11-15 Macros/Variables/Aliases Dialog Box
Macros tab
Click this tab to import, create, edit, and delete macros. For detailed reference information, see Macros Tab.
Note
Variables tab
Click this tab to create, edit, and delete variables. For detailed reference information, see Variables Tab.
Note
Global Libraries tab
Click this tab to create, edit, and delete variable group types, and create, edit and delete variable types. For detailed reference information, see Global Libraries Tab.
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:
•
•
Note
How to Get to This TabOn the Properties tab or the Macro Assignments tab, click Macros & Variables.
Related TopicsField Reference
Table 11-16 Macros Tab
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, then 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
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 BoxDo one of the following:
•
•
•
Related TopicsField Reference
Table 11-17 Edit Macro Dialog Box
Name
The name of the macro.
Description
A word or phrase that describes the purpose of the macro.
Event Name
The name of the event.
Event Type
The type of event. For a complete list of event types, see Events.
Target Device Type
The device type on which the macro is run. Click the list box to display a list of target types.
Auto Correcting
Check the Auto Correcting 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 to 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 checked, but the macro is not designed in this fashion, it will not make corrections.
Comment
(Optional) Any additional information about the macro.
OS Versions
Tags that define OS versions supported by the devices assigned to the macro for the macro to function properly. To use this field, do one of the following:
•
•
When you add or edit an OS Version tag, the OS Version Editor dialog box appears. Click Exact Value to specify an exact version number or click Version Pattern to specify a 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:
•
•
•
•
•
•
For example, to designate a macro for all CSMs running 4.2(5) OS version, you can use any of the following expressions:
•
•
•
Note
External Macro References
The names of macros that are referenced from this macro. Click New to add macro references. Click a macro and then click Delete 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
This field provides the same functions as the Variable tab. For more information about this field, see Variables Tab.
Macro Body
The 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 TabIn the Macros/Variables/Aliases Dialog Box, click the Variables tab.
Related TopicsField Reference
Table 11-18 Variables Tab
Name
The 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. The names are displayed as a hierarchical tree to show the relationships between items.
The variables shown in bold are default variables, and the variables shown in plain text are user-created variables. For more details about default variables, see Appendix A, "System Actions, Default Variables, and Resource Attribute Variables."
Description
Word or phrase describing the variable, variable group, element, macro, or macro file container.
Type
The type of variable.
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 Global Libraries and Variables, page 12-1
Optional
Indicates that a value is not required for the variable.
Default/Fixed Value
The value assigned to the variable, if present.
New
Do one of the following:
•
•
Move Up/Move Down
Click an item and then click Move Up or Move Down 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
Click a variable or variable group and then click Edit to edit the variable or variable group. For details, see Variable Dialog Box, page 12-15 and Variable Group Dialog Box, page 12-13.
Delete
Click a variable or variable group and then click Delete to delete the variable or variable group.
Global Libraries Tab
Use the Global Libraries tab to create, edit and delete variable types and variable group types.
How to Get to This TabOn the Macros/Variables/Aliases Dialog Box, click the Global Libraries tab.
Related TopicsField Reference
Table 11-19 Global Libraries Tab
Name
The 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. The names are displayed as a hierarchical tree to show the relationships between items.
The variables shown in bold are default variables, and the variables shown in plain text are user-created variables. For more details about default variables, see Appendix A, "System Actions, Default Variables, and Resource Attribute Variables."
Description
Word or phrase describing the variable, variable group, element, macro, or macro file container.
Type
The type of variable.
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 Global Libraries and Variables, page 12-1.
Optional
Indicates that a value is not required for the variable.
Default Value
The default value assigned to the variable.
Restricted Value
The restricted value assigned to the variable.
Aliases Tab
Use the Aliases tab to view, create, edit, and delete aliases for variables or variable groups.
How to Get to This TabOn the Macros/Variables/Aliases Dialog Box, click the Aliases tab.
Related TopicsField Reference
Alias Dialog Box
Use the Alias dialog box to define aliases for variables or variable groups.
How to Get to This Dialog BoxOn the Aliases tab, double-click an alias or alias group, or click an existing alias and then click New Alias for Variables or New Alias for Variable Groups.
Related TopicsField Reference
Table 11-21 Aliases Dialog Box
Name
The name of the alias.
Description
A word or phrase that describes the alias.
Set Primary Variable
After defining variables or variable groups for the alias, click one of the variables or variable groups and then click Set Primary Variable. 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
The variables belonging to the selected alias.
Variables
Lists all variables and variable groups in the template:
•
•
•
•
•
If a variable is set to multivalue, you must assign resource pools, not single values, as the value. For more information, see Understanding Global Libraries and Variables, page 12-1.
•
•
Add
Click Add 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
Click Remove to remove the variable or variable group selected in the Alias Contents field from the selected alias.
Supported Targets Dialog Box
Use this dialog box to choose supported targets and constraint types.
How to Get to This Dialog BoxOn the Properties tab, click Edit Targets.
Related TopicsField Reference
Table 11-22 Supported Targets Dialog Box
Selector
Various lists of devices. See Table 11-1 for a list of supported targets.
Edit Macro Assignment Dialog Box
Use this dialog box to assign macros to targets and events.
How to Get to This Dialog BoxDo one of the following:
•
•
Related TopicsField Reference
Table 11-23 Edit Macro Assignment Dialog Box
Logical Element
The name of the selected logical element.
Target Device Type
The target to which the macro is assigned.
Event
The event that triggers the macro to run.
Available Macros
The list of macros that have been created or imported for the selected logical element.
Import Macros
Click Import to import macros that were created outside of VFrame or that were created from another VFrame server and exported.
Note
Create Macros
Click a macro file container and then click Create Macros to create a macro. For more information, see Edit Macro Dialog Box.
Edit
Do one of the following:
•
•
Show Matching Macros
Check the Show Matching Macros check box to filter the list of macros to be only those that support the selected target type.
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:
•
•
•
•
•
•
•
•
•
•
•
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•
Note
Related Topics•
Field Reference
Storage Managers Dialog Box
Use the Storage Managers tab to create storage templates and to define storage managers. Depending on whether you choose a storage template or storage manager in the Storage Manager Templates selector, different tabs appear. All tabs are described in Table 11-25.
How to Get to This TabChoose View > Storage Managers.
Related Topics•
•
Field Reference
Table 11-25 Storage Managers Tab
New
Do one of the following:
•
•
Edit
Click Edit to edit the selected storage manager template or storage manager.
Delete
Click Delete to delete the open and selected template or storage manager.
Note
Clone
Click Clone to duplicate the selected template and assign it a different name.
Import
Click Import 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
Click Export 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 selector for it.
Macro Assignments tab
Enables you to assign macros to targets and events. Also allows you to create and import macros and macro file containers, and define variables, variable groups, and aliases. For detailed reference information, see Macro Assignments Tab.
Variable Values tab
Enables you to define the variable values for storage managers within your service network. For detailed reference information, see Variable Values Tab (LOM 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 Dialog BoxIn the Storage Managers Dialog Box, click a template and then click New.
Related Topics•
•
•
Field Reference
Variable Values 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
On 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
LOM Managers Dialog Box
Use the LOM Managers tab to create LOM manager templates and define LOM managers.
How to Get to This Dialog BoxChoose View > LOM Managers to open the LOM Managers tab.
Related Topics•
•
Field Reference
Table 11-28 LOM Managers Tab
New
Click LOM Manager Templates in the LOM Manager Templates selector and then click New to create a new LOM manager template. The LOM Manager Template dialog box appears so that you can define a name and description for the LOM manager template that you are creating.
Edit
Click Edit to edit the selected LOM manager template or LOM manager.
Delete
Click Delete to delete the open and selected LOM manager template or LOM manager.
Import
Click Import 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
Click Export 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 selector for it.
Macro Assignments tab
Enables you to assign macros to targets and events. Also allows you to create and import macros and macro file containers and define variables, variable groups, and aliases. For detailed reference information, see Macro Assignments Tab.
Variable Values tab
Enables you to define the variable values for LOM managers within your service network. For detailed reference information, see Variable Values Tab (LOM Managers).
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 Dialog BoxIn the LOM Managers Dialog Box, click a template and then click New.
Related Topics•
•
Field Reference
Variable Values 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 TabOn the LOM Managers Dialog Box, create a new LOM template or open an existing LOM template, and then click New.
Related Topics•
Field Reference
