System Management Configuration Guide, Cisco DCNM for SAN, Release 7.x

Job Sources

Each configuration delivery job is based on a source. This section includes the following topics:

• Template-Sourced Jobs

Template-Sourced Jobs

Template-Sourced Jobs

You can use templates that you create to configure the Cisco IOS and Cisco NX-OS commands to be sent to destination devices. For configuration delivery jobs based on a template source, you select the desired template and then configure the parameters for each instance of the template that you add to the job.

Note For information about creating templates, see the Cisco DCNM System Management Configuration Guide, Release 5.x.

For each destination device that is included in the job, you can configure only one instance of the template.

Note Template-sourced jobs do not support show commands, interactive commands, or commands that give command progress as output, such as the copy running-config startup-config command.

Delivery Options

For each configuration delivery job, you can specify how Cisco DCNM should respond if a failure occurs during the job. Cisco DCNM can continue the job regardless of errors, stop the job on all devices that are included in the job, or stop the job only on the device where the failure occurred but continue the job on other devices. If a job is delivering the same configuration to many devices, you may want Cisco DCNM to stop delivering the job to all devices if a single failure occurs, rather than risk delivering the same configuration error to all devices.

If the devices included in a job support the rollback feature, Cisco DCNM can use the rollback feature if a failure is encountered during a job. For example, Cisco Nexus 7000 Series devices support the rollback feature. You can specify that Cisco DCNM rolls back to the previous running configuration on the device that had the failure only or on all devices included in the job. You can also specify that Cisco DCNM should roll back to the previous running configuration on the device that had the failure and stop the job.

You can also specify whether Cisco DCNM delivers the configuration to all devices included in the job at the same time (parallel delivery) or if it delivers the configuration to devices one at a time (sequential delivery). While parallel delivery finishes configuring all the devices in a job more quickly, consider using sequential delivery when you would prefer that Cisco DCNM stop the delivery job to all devices if a failure occurs.

VDC Support

Cisco DCNM treats each virtual device context (VDC) on a Cisco IOS and Cisco NX-OS device as a separate device; therefore, Configuration Delivery Management allows you to configure VDCs independent of the configuration of other VDCs on the same physical device.

Configuration Delivery Templates (ASCII Text Files)

Beginning with Cisco DCNM Release 6.1(1), you can create templates for use with template-sourced jobs. These templates are ASCII text files and must comply with the requirements that are described in this section.

This section includes the following topics:

• Template Format
• Template Properties Section
• Template Content Section
• Example Template

Template Format

Each template that you create must have a properties section and a content section. Example 9-1 shows the required template format.

Example 9-1 Template Format

Template Properties Section

The template properties section must include the following two attribute-value pairs:

• name—Name of the template to be displayed in the Cisco DCNM client. The template name must be unique. No other template on the Cisco DCNM server should specify the same template name value. Specify the name in the following format:

For example:

• description—Description of the template, in the following format:

For example:

Each of the two attribute-value pairs must end in a semicolon (;).

Template Content Section

The template content section contains the Cisco IOS and the Cisco NX-OS configuration commands and any parameters that you want to include in the template. Commands must not include prompts for answers and must not return progress output, such as the copy running-config startup-config command.

Specify the commands that you include as if you were entering them in the global configuration command mode on a Cisco IOS or a Cisco NX-OS device. You must consider the command mode when you include commands. For example, if you want to configure an interface, you must include the applicable interface command and the corresponding exit command to return to the global configuration mode.

Parameter names have two dollar symbols before and after the parameter name, as follows:

Note Beginning with Cisco DCNM Release 5.2(1), parameter names are not mandatory.

The following example includes the parameter INTF_NAME to allow the interface type and number to be user specified in a configuration delivery job:

You can include many commands in the template content section.

Example Template

Example 9-2 shows a template that can be used to apply a description to an interface on a Cisco NX-OS device. When you create a template-sourced job with this template, you would specify the INTF_NAME, DESCRIPTION, and SHUT_CMD parameters for each instance of the template in the configuration delivery job. The INTF_NAME parameter allows the template to be applicable to different interfaces types, such as port-channel interfaces versus Ethernet interfaces. The DESCRIPTION parameter allows you to specify an interface description. The SHUT_CMD parameter allows you to specify the shutdown or no shutdown command.

Example 9-2 Example of an Interface Description Template

Configuration Delivery Templates and the Cisco DCNM Client

Beginning with Cisco DCNM Release 6.1(1), you can use the configuration delivery templates feature to configure many complex features in Cisco DCNM using various predefined templates. You can also create custom templates depending on your specific requirements. The predefined and custom templates can be created using template scripts that are defined by Cisco DCNM. With the configuration delivery templates feature, you can configure and deploy multiple devices at a time.

This section includes the following topics:

• Predefined Templates
• Custom Templates

Predefined Templates

This section describes the predefined configuration delivery templates that are available in the Cisco DCNM client. Each template must have a filename that ends with a.template extension, such as port_security.template.

Cisco DCNM can use templates that are in the templates directory within the archive directory. The archive directory is specified during server installation. The default location for templates on a Microsoft Windows server is the following directory:

C:\Program Files\Cisco Systems\dcm\dcnm\data\templates

The default location for templates on a RHEL server is the following directory:

/usr/local/cisco/dcm/dcnm/data/templates

Note All the predefined templates present in DCNM-LAN client can be accessed through the DCNM-Web client, and vice versa.

Virtual Port Channel Template

To configure a virtual port channel (vPC) template on multiple devices, you must configure peer devices with peer-link port channels, vPC-enabled port channels, and an access switch with one port channel.

Cisco DCNM provides you with a peer-link access port channel template and a peer-link trunk port channel template for configuring vPC global configuration settings, peer-link port channels, and virtual access port channels. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: Virtual Port Channel Template” section.

FIP Snooping Template

To configure FCoE Initialization Protocol (FIP) snooping on multiple devices, you must configure a VLAN and interfaces that connect to an ENODE and Fibre Channel Forwarder (FCF). You can select one or more devices that you want to configure from the configuration settings for FIP snooping and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: FIP Snooping Template” section.

FCoE Template

To configure Fibre Channel over Ethernet (FCoE) on multiple devices, you must configure a VLAN, a VSAN, a virtual Fibre Channel (VFC), and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings for FCoE and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: FCoE Template” section.

OTV Internal Interfaces Template

To configure OTV internal interfaces on multiple devices, you must configure a Internal IFS, a Site VLANs, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings for OTV Internal Interfaces, and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Internal Interfaces Template” section.

OTV Multicast Template

To configure OTV Multicast on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Multicast Template” section.

OTV Multicast with HSRP Isolation Template

To configure OTV Multicast with HSRP Isolation on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Multicast with HSRP Isolation Template” section.

OTV Multicast with VRRP Isolation Template

To configure OTV Multicast with VRRP Isolation on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Multicast with VRRP Isolation Template” section.

OTV Unicast with One Adjacency Server Template

To configure OTV Unicast with one adjacency server on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, adjacency server, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Unicast with One Adjacency Server Template” section.

OTV Unicast with One Adjacency Server and HSRP Isolation Template

To configure OTV Unicast with one adjacency server on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, adjacency server, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Unicast with One Adjacency Server and HSRP Isolation Template” section.

OTV Unicast with One Adjacency Server and VRRP Isolation Template

To configure OTV Unicast with one adjacency server on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, adjacency server, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Unicast with One Adjacency Server and VRRP Isolation Template” section.

OTV Unicast with Two Adjacency Servers Template

To configure OTV Unicast with one adjacency server on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, the primary and secondary adjacency servers, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Unicast with Two Adjacency Servers Template” section.

OTV Unicast with Two Adjacency Servers and HSRP Isolation Template

To configure OTV Unicast with one adjacency server on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, the primary and secondary adjacency servers, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Unicast with Two Adjacency Servers and HSRP Isolation Template” section.

OTV Unicast with Two Adjacency Servers and VRRP Isolation Template

To configure OTV Unicast with one adjacency server on multiple devices, you must configure a Site VLAN, a Site ID, an Overlay,a control group, the primary and secondary adjacency servers, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: OTV Unicast with Two Adjacency Servers and VRRP Isolation Template” section.

Virtual Port Channel Template

To configurevirtual port channel on multiple devices, you must configure a VPC ID, an Channel number,VLAN account,, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: Virtual Port Channel Template” section.

Zone Template

TTo configurevirtual port channel on multiple devices, you must configure a hostname, storage, VSAN ID, host, zone set, and multiple interfaces. You can select one or more devices that you want to configure from the configuration settings and enter the correct values in the respective fields. For more information about the field descriptions, see the “Configuration Delivery for Templates: Zone Template” section.

Custom Templates

You can create, edit, and delete custom templates depending on your specific requirements. The user interface for a custom template is created dynamically based on the template. To create a custom template, you need to understand the syntax rules that are defined in the Cisco DCNM template definition file.

RELATED TOPICS

• Adding a Custom Template in the Cisco DCNM SAN Client
• Importing a Custom Template in the Cisco DCNM SAN Client
• Exporting a Custom Template in the Cisco DCNM SAN Client
• Changing a Custom Template in the Cisco DCNM Client
• Removing a Custom Template in the Cisco DCNM Client

Configuration Delivery Template Requirements

Beginning with Cisco DCNM Release 6.1(1), you can create configuration delivery templates with the Cisco DCNM client. When you create custom templates or modify existing templates, the template must comply with the requirements that are described in this section.

This section includes the following topics:

• Template Format
• Template Properties Section
• Template Variable Section
• Template Content Section
• Example Template
• Template Data Types

Template Format

Each template that you create must have a properties section and a content section. Example 9-3 shows the custom template format.

Note When creating or changing a template, ensure that the userDefined property is set to “true.” If the userDefined property is “false” and the template is deployed, then the template becomes permanent and cannot be deleted.

Example 9-3 Custom Template Format

exit

Template Properties Section

The template properties section must include the name attribute-value pair and the description attribute-value pair. Other attribute-value pairs are optional:

• name—Name of the template to be displayed in the Cisco DCNM client. The template name must be unique. No other template on the Cisco DCNM server should specify the same template name value. Specify the name in the following format:

For example:

• description—Description of the template, in the following format:

For example:

• (Optional) supportedPlatforms—List of device platforms that are supported.
  The valid values for this attribute are C6500, N1K, N1010, N3K, N4K, N5K, N5500, or N7K. The values must be specified in a comma-delimited list.

For example:

Note If the supportedPlatforms attribute is not specified, the template is applicable for all platforms.

• (Optional) unsupportedPlatforms—List of device platforms that are not supported.
  The valid values for this attribute are C6500, N1K, N1010, N3K, N4K, N5K, N7K, or N5500. The values must be specified in a comma-delimited list.

For example:

Note All specified attribute-value pairs must end in a semicolon (;).

Template Variable Section

The template variable section contains the data type, default values, and valid values conditions for the parameters that are used in the template. The template variable section is optional. If you do not provide this section, Cisco DCNM parses the variables from the template content section. The type of the parsed parameters is a string by default.

Template Content Section

The template content section contains the Cisco IOS and the Cisco NX-OS configuration commands and any parameters that you want to include in the template. Specify the commands that you include as if you were entering them in the global configuration command mode on a Cisco IOS or a Cisco NX-OS device. You must consider the command mode when you include commands.

Parameter names have two dollar symbols before and after the parameter name, as follows:

$$parameter$$

Note Beginning with Cisco DCNM Release 5.2(1), parameter names are not mandatory.

Implicit Template Variables

Cisco DCNM supports four implicit template variables, DEVICE_NAME, DEVICE_IP, DEVICE_TYPE, and DEVICE_IMG_VERSION.

DEVICE_NAME represents the device name.

DEVICE IP represents the device management IP.

DEVICE_TYPE represents a target device platform. The valid values are C6500, N1K, N1010, N3K, N4K, N5K, N7K or N5500.

For example, the DEVICE_TYPE variable can be used in an if construct:

if ($$DEVICE_TYPE$$ == "N7K" || $$DEVICE_TYPE$$ == "N1010")

DEVICE_IMG_VERSION represents a target device image version.

Foreach Loop Construct

The DCNM template engine supports a foreach loop construct. This construct is used for template configurations that are required for a set of interfaces or VLAN IDs.

The syntax for the construct is a follows:

For example:

If Conditional Construct

The DCNM template engine supports the if | else if | else loop construct. This construct is used for template configurations that need to be applied based on specific conditions.

Note Make sure that the else if and else blocks start on a new line after an if block.

For example:

Example Template

Example 9-4 shows a template that can be used to apply a description to configuring FCoE on a Cisco NX-OS device. When you create a template for configuration delivery management with this template, you would specify the NAME, DESCRIPTION, VLAN_ID_RANGE, and VFC_PORT_NUM_RANGE parameters for each instance of the template.

Example 9-4 Example of an FCoE Template

Example 9-5 shows a FIP Snooping template.

Example 9-5 Example of a FIP Snooping Template

Template Data Types

Template data types are used to build templates. Associated with each data type are certain metadata properties that are used by the template engine to validate the values for the data type.

to show an overview of template data types that are used to build templates, metadata properties, and the association of data types and metadata properties.

Table 9-1 Overview of Data Types

All data types have some metadata properties. The following table shows all the possible metadata properties for all data types.

Table 9-2 Metadata Properties

The following table shows the association of data types and metadata properties.

Table 9-3 Association of Data Types and Metadata Properties

Creating a Configuration Delivery Management Job

Creating a configuration delivery management job has many steps, which vary depending upon the type of job that you are creating. This procedure summarizes the creation of a configuration delivery job and directs you to more detailed procedures for each of the summarized steps.

Step 1 Select a Add a configuration delivery job of the type that you need.

For more information, see the “Adding a Configuration Delivery Job” section.

Step 2 Add one or more destination devices for the job.

For more information, see the “Adding a Predefined Template (ASCII Text Files)D” section.

Step 3 Configure the Cisco IOS and Cisco NX-OS commands to be delivered to the destination devices by the job. More information for doing so varies depending upon the type of job, as follows:

• For a job with manually entered Cisco IOS or Cisco NX-OS commands, see the “Adding a Predefined Template (ASCII Text Files)D” section.
• For a job with Cisco IOS or Cisco NX-OS commands retrieved from a source device, see the “Adding a Predefined Template (ASCII Text Files)D” section.
• For a job with Cisco IOS or Cisco NX-OS commands from a Cisco DCNM template, see the “Adding a Predefined Template (ASCII Text Files)D” section.

Note Before you can add a template-source job, you must add templates to Cisco DCNM. For more information, see the “Configuration Delivery Templates and the Cisco DCNM Client” section.

Step 4 (Optional) Configure job delivery options, which determine the following:

• How Cisco DCNM responds if a delivery job results in configuration errors on a device.
• Whether Cisco DCNM delivers Cisco IOS or Cisco NX-OS commands to all devices in the job at the same time or one device at a time.

For more information, see the “Configuring Job Delivery Options” section.

Step 5 Schedule the job.

For more information, see the “Scheduling a Configuration Delivery Job” section.

RELATED TOPICS

• Adding a Configuration Delivery Job

Adding a Configuration Delivery Job

You can add a configuration delivery job as required. You can select a template, assign it to the selected device, and define the variables for the template.You can also shcedule a job to be run on a particular device at a specific time.

BEFORE YOU BEGIN

Note that only template based jobs can be created. For more information about job types, see the “Job Sources” section.

DETAILED STEPS

Step 1 From the Feature Selector pane, choose Config > Delivery > Templates..

The Summary pane lists the configuration delivery templates that are configured in Cisco DCNM, if any. For more informtion see Adding a Predefined Template (ASCII Text Files)D

Step 2 Select a template and click on the Launch Job button to display the Config Job Wizard.

Step 3 Select the device to which you want to assign the template.

For more information see Selecting a Device

Step 4 Define variables for the template.

For more information see

Step 5 Preview the configuration in the preview pane. For more information see Previewing a Configuration

Step 6 Schedule a job. For more information see Scheduling a Configuration Delivery Job.

Step 7 Click Finish to complete the configuration delivery job creation..

Note You may be unable to deploy the job until after you have further configured the job.

RELATED TOPICS

• Creating a Configuration Delivery Management Job
• Adding a Predefined Template (ASCII Text Files)D
• Selecting a Device
• Defining Variables
• Previewing a Configuration
• Configuring Job Delivery Options
• Scheduling a Configuration Delivery Job
• Removing a Configuration Delivery Job

Selecting a Device

You can select a device to be associated with the template.

DETAILED STEPS

Step 1 From the Feature Selector pane, choose Config > Delivery > Templates..

The Summary pane lists the configuration delivery templates that are configured in Cisco DCNM, if any. For more informtion see Adding a Predefined Template (ASCII Text Files)D

Step 2 Select a template and click on the Launch Job button to display the Config Job Wizard.

Step 3 Click on the Next button to display the device selection screen.

Step 4 Select the Device Scope from the drop down list. It lists the all the devices available for selected template.

Step 5 You can view the Device, IP Address, Group, Platform, and the Version. Select the device to which you want to assign the template.

Step 6 Click Next.

Defining Variables

You can define variables for the selected device and the corresponding template.

DETAILED STEPS

Step 1 From the Feature Selector pane, choose Config > Delivery > Templates..

The Summary pane lists the configuration delivery templates that are configured in Cisco DCNM, if any. For more informtion see Adding a Predefined Template (ASCII Text Files)D

Step 2 Select a template and click on the Launch Job button to display the Config Job Wizard.

Step 3 Click on the Next button to display the device selection screen.

Step 4 After selecting the device for the template, set the variables for the device and the template.

Step 5 Enter the VSAN_ID, SLOT_NUMBER, PORT_RANGE, and the VFC_PREFIX.

Step 6 Select the Edit variables per device checkbox to set the variables for each individual devices selected for the template.

Step 7 You either keep the values global for all the devices in the list, or change the individual values in the respective rows.

Step 8 Click Next.

Previewing a Configuration

You can preview the confiuration for each device.

DETAILED STEPS

Step 1 From the Feature Selector pane, choose Config > Delivery > Templates..

The Summary pane lists the configuration delivery templates that are configured in Cisco DCNM, if any. For more informtion see Adding a Predefined Template (ASCII Text Files)D

Step 2 Select a template and click on the Launch Job button to display the Config Job Wizard.

Step 3 Click on the Next button to display the device selection screen.

Step 4 After setting the variables for the selected devices and the templates, you can preview the configuration.

Step 5 Selecta a device fron the drop down list to preview the configuration.

Step 6 Click Next.

Adding a Predefined Template (ASCII Text Files)D

You can create an ASCII text file template for use in a template-sourced configuration delivery job.

BEFORE YOU BEGIN

Review the “Configuration Delivery Templates (ASCII Text Files)” section.

DETAILED STEPS

Step 1 Create the template file, ensuring that it meets the template requirements and includes the configuration commands that you need.

Step 2 Place a copy of the template file in the templates directory. The templates directory is in the archive directory that was specified during Cisco DCNM server installation. For Microsoft Windows, the path to the default templates directory is C:\Program Files\Cisco Systems\dcm\dcnm\data\templates. For RHEL, the default path is /usr/local/cisco/dcm/dcnm/data/templates.

Step 3 Refresh the Cisco DCNM server. If you have a clustered-server Cisco DCNM deployment, you must refresh only the master server of the cluster.

For more information, see the “Refreshing Cisco DNCM Servers with Template Updates (ASCII Text Files)” section.

The new template is now available when you create a template-sourced configuration delivery job.

Adding a Custom Template in the Cisco DCNM SAN Client

With the Cisco DCNM client, you can add custom templates for deploying configuration delivery jobs.

BEFORE YOU BEGIN

Review the “Configuration Delivery Template Requirements” section.

Review the Configuration Delivery Template Requirements.

DETAILED STEPS

Step 1 From the Features Selector pane, choose Configuration Delivery > Templates .

The Summary pane lists the custom templates that are configured in the Cisco DCNM, if any.

Step 2 From the menu bar, choose Create New Config Template.

The fields for the new template appears in the Config Template pane.

Step 3 In the pane for the new template, enter the Template Name, Template Description, and Tags for the template.

Step 4 Select the appropriate check boxes for the Supported Platforms field.

Step 5 Click the Validate Template Syntax button to verify that the template does not contain errors.

If errors exist, the errors in the template are identified with red indicators in the Details pane. Cisco DCNM does not allow you to save a template that contains errors.

Step 6 Click Save to save the template details.

RELATED TOPICS

• Configuration Delivery Template Requirements
• Importing a Custom Template in the Cisco DCNM SAN Client
• Exporting a Custom Template in the Cisco DCNM SAN Client
• Changing a Custom Template in the Cisco DCNM Client
• Removing a Custom Template in the Cisco DCNM Client

Importing a Custom Template in the Cisco DCNM SAN Client

With the Cisco DCNM client, you can import custom templates for deploying configuration delivery jobs.

BEFORE YOU BEGIN

Review the “Configuration Delivery Template Requirements” section.

Review the Configuration Delivery Template Requirements.

DETAILED STEPS

Step 1 From the Features Selector pane, choose Config Delivery > Templates .

The Summary pane lists the custom templates that are configured in the Cisco DCNM, if any.

Step 2 From the menu bar, choose Import. The folder browser option is displayed.

Step 3 Navigate and select the target folder and the file.

Step 4 Once the file is selected, click OK. The selected template is imported into the DCNM and will be available for scheduling configuration deliveyr jobs.

Note The template will be validated and if there are any errors then a warning message is displayed.

RELATED TOPICS

• Configuration Delivery Template Requirements
• Exporting a Custom Template in the Cisco DCNM SAN Client
• Changing a Custom Template in the Cisco DCNM Client
• Removing a Custom Template in the Cisco DCNM Client

Exporting a Custom Template in the Cisco DCNM SAN Client

With the Cisco DCNM client, you can export custom templates for deploying configuration delivery jobs.

BEFORE YOU BEGIN

Review the “Configuration Delivery Template Requirements” section.

Review the Configuration Delivery Template Requirements.

DETAILED STEPS

Step 1 From the Features Selector pane, choose Config Delivery > Templates .

The Summary pane lists the custom templates that are configured in the Cisco DCNM, if any.

Step 2 From the menu bar, choose Export. The folder browser option is displayed.

Step 3 Navigate and select the target folder and enter the file name for the template.

Step 4 Click OK., to export the selected template to the target folder.

RELATED TOPICS

• Configuration Delivery Template Requirements
• Importing a Custom Template in the Cisco DCNM SAN Client
• Changing a Custom Template in the Cisco DCNM Client
• Removing a Custom Template in the Cisco DCNM Client

Changing a Predefined Template (ASCII Text Files)

You can change templates (ASCII text files) that are available for use in a configuration delivery job.

BEFORE YOU BEGIN

Review the “Configuration Delivery Templates (ASCII Text Files)” section.

DETAILED STEPS

Step 1 Locate the template file in the templates directory. The templates directory is in the archive directory that was specified during Cisco DCNM server installation. For Microsoft Windows, the path to the default templates directory is C:\Program Files\Cisco Systems\dcm\dcnm\data\templates. For RHEL, the default path is /usr/local/cisco/dcm/dcnm/data/templates.

Step 2 Open the template file in a text editor and make the required changes.

Step 3 Save and close the template file.

Note If you have a clustered-server Cisco DCNM deployment, you must change the template file on each Cisco DCNM server in the cluster.

Step 4 Refresh the Cisco DCNM server. If you have a clustered-server Cisco DCNM deployment, you must refresh each server in the cluster.

For more information, see the “Refreshing Cisco DNCM Servers with Template Updates (ASCII Text Files)” section.

The changed template is now available when you create a template-sourced configuration delivery job.

Changing a Custom Template in the Cisco DCNM Client

With the Cisco DCNM client, you can change custom templates created for deploying configuration delivery jobs.

BEFORE YOU BEGIN

Review the “Configuration Delivery Template Requirements” section.

Review the Configuration Delivery Template Requirements.

DETAILED STEPS

Step 1 From the Features Selector pane, choose Config Delivery > Templates .

The Summary pane lists the custom templates that are configured in the Cisco DCNM, if any.

Step 2 From the list of template, select one and choose Modify.

The fields for the template appears in the Config Template pane.

Step 3 In the pane for the selected template, enter the Template Name, Template Description, and Tags for the template.

Step 4 Select the appropriate check boxes for the Supported Platforms field.

Step 5 Click the Validate Template Syntax button to verify that the template does not contain errors.

If errors exist, the errors in the template are identified with red indicators in the Details pane. Cisco DCNM does not allow you to save a template that contains errors.

Step 6 Click Save to save the template details.

RELATED TOPICS

• Configuration Delivery Template Requirements
• Importing a Custom Template in the Cisco DCNM SAN Client
• Exporting a Custom Template in the Cisco DCNM SAN Client
• Adding a Custom Template in the Cisco DCNM SAN Client
• Removing a Custom Template in the Cisco DCNM Client

Removing a Predefined Template (ASCII Text Files)

You can remove templates (ASCII text files) from Cisco DCNM, which makes them unavailable for use in a configuration delivery job.

DETAILED STEPS

Step 1 Locate the template file in the templates directory at the following location:

INSTALL_DIR \jboss-4.2.2.GA\server\dcnm\cisco\templates

For Microsoft Windows, the path to the default Cisco DCNM installation directory is C:\Program Files\Cisco Systems. For RHEL, the default path is /usr/local/cisco.

Step 2 Delete or remove the template file from the templates directory.

Note If you have a clustered-server Cisco DCNM deployment, you must remove the template file from the templates directory on each Cisco DCNM server in the cluster.

Step 3 Refresh the Cisco DCNM server. If you have a clustered-server Cisco DCNM deployment, you must only refresh the master server.

For more information, see the “Refreshing Cisco DNCM Servers with Template Updates (ASCII Text Files)” section.

The removed template is no longer available when you create a template-sourced configuration delivery job.

Removing a Custom Template in the Cisco DCNM Client

With the Cisco DCNM client, you can delete custom templates that were created for deploying configuration delivery jobs.

DETAILED STEPS

Step 1 From the Features Selector pane, choose Config Delivery> Templates .

The Summary pane lists the custom templates that are configured in the Cisco DCNM, if any.

Step 2 From the list of template, select one.The fields for the template appears in the Config Template pane.

Step 3 From the menu bar choose Delete.

Step 4 Click Save to save the template details.

RELATED TOPICS

• Adding a Custom Template in the Cisco DCNM SAN Client
• Changing a Custom Template in the Cisco DCNM Client

Refreshing Cisco DNCM Servers with Template Updates (ASCII Text Files)

After you have made updates to templates (ASCII text files), including adding, changing, or removing templates, you must refresh the template list before users can see the updates in the Cisco DCNM client. This procedure allows you to refresh a Cisco DCNM server with updates to templates without requiring a server stop and start. If you stop and start a Cisco DCNM server after updating templates, you do not need to perform this procedure.

Note When updating templates with the Cisco DCNM client, the Cisco DCNM server is updated automatically. You do not have to manually refresh the Cisco DCNM server.

BEFORE YOU BEGIN

Update templates as needed.

If you have a clustered-server deployment, ensure that you know which server is currently operating as the master server. To do so, use the Cluster Administration feature in the Cisco DCNM client. For more information, see the Cisco DCNM Fundamentals Guide, Release 5.x.

DETAILED STEPS

Step 1 On the Cisco DCNM server, access a command prompt.

Note If you have a clustered-server deployment, ensure that you are performing these steps on the master server.

Step 2 Use the cd command to change the directory to the following location:

INSTALL_DIR \dcm\jboss-4.2.2.GA\bin

For Microsoft Windows, the path to the default Cisco DCNM installation directory is C:\Program Files\Cisco Systems. For RHEL, the default path is /usr/local/cisco.

Step 3 Enter the following command:

For example, on a Microsoft Windows server with Cisco DCNM installed in the default directory, you would enter the following command:

On a RHEL server with Cisco DCNM installed in the default directory, you would enter the following command:

Step 4 Enter the following command:

where the arguments are as follows:

• twiddle_script —Script name depending upon the server operating system, as follows:

– Microsoft Windows: twiddle.bat

– RHEL: twiddle.sh

• IP_address —IPv4 address of the Cisco DCNM server. In a clustered-server deployment, this address must be the address of the master server.
• naming_service_port —Naming Service port that the Cisco DCNM server is configured to use. By default, the Naming Service port is 1099.

For example, on a Microsoft Windows server using the default Naming Service port and the IP address 10.0.0.0, you would enter the following command:

For example, on a RHEL server using the default Naming Service port and the IP address 10.0.0.0, you would enter the following command:

The Cisco DCNM server begins using the updates to the templates.

Step 5 (Optional) To see the updates to the templates in the Cisco DCNM client, press F5 to refresh the screen.

Configuring Job Delivery Options

You can configure job delivery options for each configuration delivery job. Job delivery options allow you to specify the following:

• How Cisco DCNM responds if a delivery job results in configuration errors on a device.
• Whether Cisco DCNM delivers Cisco IOS or the Cisco NX-OS commands to all devices in the job at the same time or one device at a time.

BEFORE YOU BEGIN

Ensure that the configuration delivery job exists in Cisco DCNM.

Rollback is supported only if the Cisco IOS or the Cisco NX-OS release on the destination device supports rollbacks. For example, Cisco Nexus 7000 Series devices support rollbacks.

DETAILED STEPS

Step 1 From the Feature Selector pane, choose Config Job Wizard > VLAN Template.

The VLAN Template pane with the list of tasks is displayed.

Step 2 The Welcome screen displays the steps involvedconfiguring the job.

Step 3 Click Next to display the Select Devices screen.

Step 4 Select a device from the list to deliver the configuration.

Step 5 Click Next to display the Define Variables screen. You can enter the values for the selcted template in the Define Variables screen.

Note Select the Edit variables per device check box to set the attributes individually to each device. Else, you can globally configure the attributes to all the devices displayed in the list. Basic validation will be performed for the defined variabledand the errors are displayed.

Step 6 Click Next to preview the configuration to be delivered in the Preview Config screen.

Step 7 Click Next to display the configuration page, in Schedule Job screen. For more details, see Scheduling a Configuration Delivery Job section.

RELATED TOPICS

• Creating a Configuration Delivery Management Job
• Adding a Configuration Delivery Job
• Adding a Predefined Template (ASCII Text Files)D
• Scheduling a Configuration Delivery Job

Scheduling a Configuration Delivery Job

You can add a date and time that Cisco DCNM should run a configuration delivery job. This feature enables you to set the options if the device went wrong and the system needs to roll back to the set configuration.

BEFORE YOU BEGIN

Determine when you want Cisco DCNM to run the configuration delivery job.

DETAILED STEPS

Step 1 From the Feature Selector pane, choose Config Job Wizard > Template.

Step 2 After entering the details in the Welcome, Select Devices, Define Variables, and Preview Config screens, click Next to display the Schedule Job screen.

Step 3 Enter the job description, device credentials, time, transaction options, and the delivery options.

Step 4 Click Finish to finish the configuration.

Step 5 Choose Config Delivery > Jobs to check on the status of the running configuration delivery jobs.You can also change the scheduled time by editing the value in the Scheduled At column.

RELATED TOPICS

• Creating a Configuration Delivery Management Job
• Adding a Predefined Template (ASCII Text Files)D
• Configuring Job Delivery Options
• Removing a Configuration Delivery Job

Removing a Configuration Delivery Job

You can remove, or delete, a configuration delivery job from Cisco DCNM.

DETAILED STEPS

Step 1 From the Feature Selector pane, choose Config Delivery> Jobs.

The Summary pane lists the configuration delivery jobs that are configured in Cisco DCNM.

Step 2 Click the configuration delivery job check box that you want to remove.

Step 3 From the menu bar, click the Delete Job button.

Step 4 Click Yes.

Cisco DCNM removes the configuration delivery job. You do not need to save your changes.

Delivery Job: Details: Configuration Section

Delivery Job: Details: Configuration Delivery Options Section

Configuration Delivery for Templates: FCoE Template

Configuration Delivery for Templates: FIP Snooping Template

Configuration Delivery for Templates: OTV Internal Interfaces Template

Configuration Delivery for Templates: OTV Multicast Template

Configuration Delivery for Templates: OTV Multicast with HSRP Isolation Template

Configuration Delivery for Templates: OTV Multicast with VRRP Isolation Template

Configuration Delivery for Templates: OTV Unicast with One Adjacency Server Template

Configuration Delivery for Templates: OTV Unicast with One Adjacency Server and HSRP Isolation Template

Configuration Delivery for Templates: OTV Unicast with One Adjacency Server and VRRP Isolation Template

Configuration Delivery for Templates: OTV Unicast with Two Adjacency Servers Template

Configuration Delivery for Templates: OTV Unicast with Two Adjacency Servers and HSRP Isolation Template

Configuration Delivery for Templates: OTV Unicast with Two Adjacency Servers and VRRP Isolation Template

Configuration Delivery for Templates: Virtual Port Channel Template

Configuration Delivery for Templates: Zone Template

Related Documents

Standards