System Management Configuration Guide, Cisco DCNM for LAN, Release 5.x
Using Configuration Delivery Management
Downloads: This chapterpdf (PDF - 380.0KB) The complete bookPDF (PDF - 4.07MB) | Feedback

Using Configuration Delivery Management

Table Of Contents

Using Configuration Delivery Management

Information About Configuration Delivery Management

Job Sources

Template-Sourced Jobs

Device-Sourced Jobs

Manual-Sourced Jobs

Port Profile Integration

Delivery Options

VDC Support

Configuration Delivery Templates (ASCII Text Files)

Template Location and Filenaming Convention

Template Format

Template Properties Section

Template Content Section

Example Template

Configuration Delivery Templates and the Cisco DCNM Client

Predefined Templates

Custom Templates

Configuration Delivery Template Requirements

Template Format

Template Properties Section

Template Variable Section

Template Content Section

Example Template

Template Data Types

Licensing Requirements for Configuration Delivery Management

Prerequisites for Configuration Delivery Management

Guidelines and Limitations for Configuration Delivery Management

Platform Support

Using Configuration Delivery Management

Creating a Configuration Delivery Management Job

Adding a Configuration Delivery Job

Configuring Job Destination Devices

Configuring Cisco IOS and Cisco NX-OS Commands for a Device Command Interface Job

Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Expert Job

Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Template Center

Adding a Template (ASCII Text Files)

Adding a Custom Template in the Cisco DCNM Client

Changing a Template (ASCII Text Files)

Changing a Custom Template in the Cisco DCNM Client

Removing a Template (ASCII Text Files)

Removing a Custom Template in the Cisco DCNM Client

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

Configuring Job Delivery Options

Scheduling a Configuration Delivery Job

Removing a Configuration Delivery Job

Field Descriptions for Configuration Delivery Management

Delivery Job: Details: Configuration Section

Delivery Job: Details: Configuration Delivery Options Section

Configuration Delivery for Templates: Virtual Port Channel Template

Configuration Delivery for Templates: FIP Snooping Template

Configuration Delivery for Templates: FCoE Template

Additional References

Related Documents

Standards

Feature History for Configuration Delivery Management


Using Configuration Delivery Management


This chapter describes how to use the Configuration Delivery Management feature in Cisco Data Center Network Management (DCNM).

This chapter includes the following sections:

Information About Configuration Delivery Management

Licensing Requirements for Configuration Delivery Management

Prerequisites for Configuration Delivery Management

Guidelines and Limitations for Configuration Delivery Management

Platform Support

Using Configuration Delivery Management

Field Descriptions for Configuration Delivery Management

Additional References

Feature History for Configuration Delivery Management

Information About Configuration Delivery Management


Note Beginning with Cisco Release 5.2(1), Cisco DCNM supports the Cisco IOS platform.


The Configuration Delivery Management feature allows you to configure Cisco IOS and Cisco NX-OS features that Cisco DCNM does not support directly in the Cisco DCNM client user interface. For example, you can use Configuration Delivery Management to configure the Enhanced Interior Gateway Routing Protocol (EIGRP) for Cisco Nexus 7000 Series devices.

With the Configuration Delivery Management feature, you create and schedule configuration delivery jobs. Each job can send device configuration commands to one or more devices.

Beginning with Cisco DCNM Release 5.2(1), this feature supports Cisco Catalyst 6500 Series, Cisco Nexus 1000 Series, Cisco Nexus 1010 Series, Cisco Nexus 3000 Series, Cisco Nexus 4000 Series, Cisco Nexus 5000 Series, and Cisco Nexus 7000 Series devices.

This section includes the following topics:

Job Sources

Port Profile Integration

Delivery Options

VDC Support

Configuration Delivery Templates (ASCII Text Files)

Configuration Delivery Templates and the Cisco DCNM Client

Configuration Delivery Template Requirements

Job Sources

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

Template-Sourced Jobs

Device-Sourced Jobs

Manual-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.

For each destination device that is included in the job, you can configure one or more instances of the template. Each instance of the template is added as a template row in the command configuration of a destination device.


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.


Device-Sourced Jobs

You can use the running configuration or the startup configuration of a managed device to configure the Cisco NX-OS commands to be sent to destination devices. For configuration delivery jobs based on a device source, you specify the show running-config or show startup-config command that Cisco DCNM should use to retrieve the relevant commands from the source device and then select the commands that you want from the retrieved command output.


Note Device-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.


Manual-Sourced Jobs

You can manually specify the Cisco IOS and Cisco NX-OS configuration commands to be sent to destination devices. For configuration delivery jobs based on a manual source, you enter or paste the configuration command text directly in the Cisco DCNM client as you would on a Cisco IOS and Cisco NX-OS command-line interface (CLI).


Note Manual-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.


Port Profile Integration

You can use the Port Profiles feature to create a configuration delivery job. After you have configured a port profile with the settings that you want to deliver to other managed devices, you can use the Copy to Multiple Devices option to create the configuration delivery job.

For more information, see the Interfaces Configuration Guide, Cisco DCNM for LAN, Release 5.x.

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 5.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 Location and Filenaming Convention

Template Format

Template Properties Section

Template Content Section

Example Template

Template Location and Filenaming Convention

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

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
name = template_name;
description = template_description;
##
##template content
configuration_commands
##
 
   

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:

name = template_name;
 
   

For example:

name = Interface Description Template;
 
   

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

description = template_description;
 
   

For example:

description = This file specifies the template for setting interface description;
 
   

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:

$$parameter$$

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:

interface $$INTF_NAME$$
 
   

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

##template properties
name = Interface Description Template;
description = This file specifies the template for setting interface description;
##
 
   
##template content
interface $$INTF_NAME$$
 description $$DESCRIPTION$$
 $$SHUT_CMD$$
exit
##
 
   

Configuration Delivery Templates and the Cisco DCNM Client

Beginning with Cisco DCNM Release 5.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.

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.

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.

Configuration Delivery Template Requirements

Beginning with Cisco DCNM Release 5.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

##template properties
name = FCOE Template;
description = This file specifies the template configuration for FCOE;
userDefined=true;
##
 
   
##template content
feature fcoe
fcoe fcmap $$FC_MAP$$
vsan database
vsan $$VLAN_ID_RANGE$$

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:

name = template name;
 
   

For example:

name = FCoE Template;
 
   

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

description = template description;
 
   

For example:

description = This file specifies the template for setting FCoE
 
   

(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:

supportedPlatforms = N5K, N7K;

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:

unsupportedPlatforms = N5K, N7K;

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 two implicit template variables, DEVICE_TYPE and DEVICE_IMG_VERSION.

DEVICE_TYPE is used to represent 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 is used to represent 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:

foreach <FOR_LOOP_VARIABLE> in $$FOR_LOOP_RANGE$$  
{<SET of commands with placeholders for a for loop index variable, such as 
@FOR_LOOP_VARIABLE>
 
   

For example:

##template properties
name = FCOE Template;
description = This file specifies the template configuration for FCOE;
userDefined=false;
##
##template variables
integerRange VLAN_ID_RANGE;
integerRange VFC_PORT_NUM_RANGE;
##
##template content
feature fcoe
fcoe fcmap $$FC_MAP$$
vsan database
vsan $$VLAN_ID_RANGE$$
exit
 
   
foreach VLAN_ID in $$VLAN_ID_RANGE$$ {
vlan @VLAN_ID
fcoe vsan @VLAN_ID
exit
}
foreach VFC_PORT_NUM in $$VFC_PORT_NUM_RANGE$$ {
interface vfc @VFC_PORT_NUM
bind interface ethernet 1/@VFC_PORT_NUM
no shutdown
exit
 
   
foreach VLAN_ID in $$VLAN_ID_RANGE$$ {
vsan database
vsan @VLAN_ID interface vfc @VFC_PORT_NUM
exit
}
}
##

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:

##template properties
name = FCOE Template;
description = This file specifies the template configuration for FCOE;
userDefined=false;
##
##template variables
integerRange VLAN_ID_RANGE;
integerRange VFC_PORT_NUM_RANGE;
##
##template content
feature fcoe
if ($$FC_MAP$$) {
## deliver only if there is a valid value given for FC_MAP
fcoe fcmap $$FC_MAP$$
}
vsan database
vsan $$VLAN_ID_RANGE$$
exit
if ($$DEVICE_TYPE$$ == "N7K" && $$ DEVICE_IMG_VERSION$$ == "4.2(3)") {
<some commands specific to N7K with image version 4.2(3)>
}
else if ($$DEVICE_TYPE$$ == "N7K") {
<commands specific to N7K with any image other than 4.2(3)>
}
else if ($$DEVICE_TYPE$$ == "N5K") {
<commands specific to N5K device>
}
else {
<commands specific to any device other than N7K and N5K>
}
##

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

##template properties
name = FCOE Template;
description = This file specifies the template configuration for FCOE;
userDefined=true;
##
##template variables
integerRange VLAN_ID_RANGE;
integerRange VFC_PORT_NUM_RANGE;
##
##template content
feature fcoe
fcoe fcmap $$FC_MAP$$
vsan database
vsan $$VLAN_ID_RANGE$$
exit

Example 9-5 shows a FIP Snooping template.

Example 9-5 Example of a FIP Snooping Template

##template properties
name = FIP SNOOPING Template;
description = This file specifies the template configuration for FIP Snooping;
userDefined=false;
supportedPlatforms = N4K, N4K;
N4K.supportedImages = 4.1(2)N1(1);
N4K.supportedImages = 4.1(2)N1(1);
##
##template content
feature fip-snooping
vlan $$VLAN_ID$$
fip-snooping enable
fip-snooping fc-map $$FC_MAP$$
exit
interface $$ENODE_INF$$
no fip-snooping port-mode fcf
switchport mode trunk
switchport trunk allowed vlan $$VLAN_ID$$
switchport trunk allowed vlan add $$OLD_VLAN_ID$$
switchport trunk native vlan $$OLD_VLAN_ID$$
spanning-tree port type edge trunk
lldp receive
lldp transmit
exit
interface $$FCF_INF$$
switchport mode trunk
switchport trunk allowed vlan add $$VLAN_ID$$
fip-snooping port-mode fcf
exit
##

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

Data Type
Description

boolean

A Boolean value.

Example: true

enum

Value that is any one of the string values from a fixed set of strings.

Example: [pagp,lacp] or [running-config,startup-config]

float

Value that is a signed real number.

Example: 10.08 or -8.08

floatRange

Value that is a range of signed real numbers.

Example: 100.08 - 110.08

integer

Value that is a signed number.

Example: 100 or -120

integerRange

Value that is a range of signed numbers.

Example: -120 - -100 or -120 - 100

interface

Value that is the name of an interface/port.

Example: FastEthernet1/10

interfaceRange

Value that is a range of interface/port names.

Example: FastEthernet 1/10-18, Gi 2/8, or Gi 3/5-8

ipV4Address

Value that is an IP address version 4.

Example: 10.8.8.8

ipV6Address

Value that is an IP address version 6.

Example: 10:8:8:10:4:6

ipAddress

Value that is either an IP v4 Address or IP v6 Address.

macAddress

Value that is a MAC address.

Example: 02.00.4C.4F.4F.50

string

Value that is a literal string.

Example: abc or def


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

Metadata Property
Description

defaultValue

Default value of the data type.

For an integer data type, an example is defaultValue = 8.

validValues

Valid values that are allowed for the data type.

For an integer data type, an example is validValues=1,5,8,10-100.

decimalLength

Number of digits allowed after the decimal point for a float value.

If a value has more digits than the length specified, the template engine truncates the value.

For a float value of length 2, an example is decimalLength = 2.

min

Minimum value for the data type.

An example is min=1.2345.

max

Maximum value tor the data type.

An example is max=10.10.

minSlot

Minimum valid slot number.

The template engine validates that the given interface name is of a port whose card is placed either in a given slot or in a slot that comes after the minimum slot number.

An example is minSlot=2.

maxSlot

Maximum valid value slot number.

The template engine validates that the given interface name is of a port whose card is placed either in the given slot or in a slot that comes before the maximum slot number.

An example is maxSlot=12.

minPort

Minimum port number.

The template engine validates that the port number in the given interface name is less than or equal to that of the minimum port number.

This property is applicable for logical port numbers also.

An example is minPort=2.

maxPort

Maximum port number.

The template engine validates that the port number in the given interface name is greater than or equal to that of the maximum port number.

This property is applicable for logical port numbers also.

An example is maxPort=8.

minLength

Minimum number of characters in a string value.

An example is minLength=5.

maxLength

Maximum number of characters in a string value.

An example is maxLength=255.

regularExpr

Regular expression that the template engine matches to a string value.

If the string value does not match the given regular expression, the template engine raises an error.

Note This property expects regular expressions that are in an acceptable format used by Java.

An example is regularExpr=.*abc.*.


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

Table 9-3 Association of Data Types and Metadata Properties

Data Type
Metadata Property

boolean

defaultValue

enum

defaultValue

validValues
Example: validValues= pagp, lacp.

float

defaultValue

validValues

decimalLength

min

max

floatRange

defaultValue

validValues

decimalLength

min

max

integer

defaultValue

validValues

min

max

integerRange

defaultValue

validValues

min

max

interface

defaultValue

validValues

minSlot

maxSlot

minPort

maxPort

interfaceRange

defaultValue

validValues

minSlot

maxSlot

minPort

maxPort

ipV4Address

This data type does not support any metadata properties.

ipV6Address

This data type does not support any metadata properties.

ipAddress

This data type does not support any metadata properties.

macAddress

This data type does not support any metadata properties.

string

defaultValue

validValues

minLength

maxLength

regularExpr


Licensing Requirements for Configuration Delivery Management

The following table shows the licensing requirements for this feature:

Product
License Requirement

Cisco DCNM

Configuration Delivery Management requires no license. Any feature not included in a license package is bundled with Cisco DCNM and is provided at no charge to you. For information about obtaining and installing a Cisco DCNM LAN Enterprise license, see the Cisco DCNM Installation and Licensing Guide, Release 5.x.

Cisco NX-OS

Using the Configuration Delivery Management feature with a Cisco NX-OS device requires no Cisco NX-OS license; however, Cisco NX-OS features that require a license can be configured by Configuration Delivery Management only if the Cisco NX-OS device has the applicable license installed. For an explanation of the Cisco NX-OS licensing scheme for your platform, see the licensing guide for your platform.


Prerequisites for Configuration Delivery Management

The Configuration Delivery Management feature has the following prerequisites:

The Configuration Delivery Management feature supports only devices that are managed by Cisco DCNM, which means that Cisco DCNM must have successfully discovered the device.

Devices must be reachable by Cisco DCNM when Cisco DCNM attempts to deliver the configuration. A delivery job fails if the device is unreachable by Cisco DCNM.

Guidelines and Limitations for Configuration Delivery Management

Configuration Delivery Management has the following configuration guidelines and limitations:

The following types of Cisco IOS and the Cisco NX-OS configuration commands are not supported with Configuration Delivery Management:

Interactive configuration commands (that is, any command that includes prompts for user input).

Commands that give command progress as output, such as the copy running-config startup-config command.

Rollback is supported for configuration delivery only if the destination device supports the rollback feature. For example, Cisco Nexus 7000 Series devices support rollback, but Cisco Nexus 1000V Series switches do not.

Platform Support

The following platforms support this feature but might implement it differently. For platform-specific information, including guidelines and limitations, system defaults, and configuration limits, see the corresponding documentation.

Platform
Documentation

Cisco Catalyst 6500 Series switches

Cisco Catalyst 6500 Series Switches Documentation

Cisco Nexus 1000V Series switches

Cisco Nexus 1000V Series Switch Documentation

Cisco Nexus 3000 Series switches

Cisco Nexus 3000 Series Switch Documentation

Cisco Nexus 4000 Series switches

Cisco Nexus 4000 Series Switch Documentation

Cisco Nexus 5000 Series switches

Cisco Nexus 5000 Series Switch Documentation

Cisco Nexus 7000 Series switches

Cisco Nexus 7000 Series Switch Documentation


Using Configuration Delivery Management

This section includes the following topics:

Creating a Configuration Delivery Management Job

Adding a Configuration Delivery Job

Configuring Job Destination Devices

Configuring Cisco IOS and Cisco NX-OS Commands for a Device Command Interface Job

Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Expert Job

Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Template Center

Adding a Template (ASCII Text Files)

Adding a Custom Template in the Cisco DCNM Client

Changing a Template (ASCII Text Files)

Changing a Custom Template in the Cisco DCNM Client

Removing a Template (ASCII Text Files)

Removing a Custom Template in the Cisco DCNM Client

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

Configuring Job Delivery Options

Scheduling a Configuration Delivery Job

Removing a Configuration Delivery Job

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 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 "Configuring Job Destination Devices" 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 "Configuring Cisco IOS and Cisco NX-OS Commands for a Device Command Interface Job" section.

For a job with Cisco IOS or Cisco NX-OS commands retrieved from a source device, see the "Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Expert Job" section.

For a job with Cisco IOS or Cisco NX-OS commands from a Cisco DCNM template, see the "Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Template Center" 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.


Adding a Configuration Delivery Job

You can add a configuration delivery job as needed.

BEFORE YOU BEGIN

Determine what type of job you want to add: manual, device based, or template based. For more information about job types, see the "Job Sources" section.

DETAILED STEPS


Step 1 From the Feature Selector pane, choose Configuration Change Management > Configuration Delivery Management.

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

Step 2 From the menu bar, create the job, as follows:

For a manual-sourced job, choose File > New > Device Command Interface.

For a device-sourced job, choose File > New > Configuration Expert.

For a template-sourced job, choose File > New > Configuration Template Center.

The Summary pane displays a new configuration delivery job.

Step 3 In the Comment column, double-click the entry for the new job and enter a useful comment about the configuration delivery job that you are creating.

Step 4 Click on any other field in the Summary pane.

On the toolbar, the Deploy button becomes available.

Step 5 (Optional) From the menu bar, choose File > Deploy to save the new configuration delivery job to the Cisco DCNM server.


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



Configuring Job Destination Devices

You can add or remove destination devices from a configuration delivery job. Destination devices are the managed devices to which Cisco DCNM delivers the Cisco IOS and the Cisco NX-OS commands when it runs the job.

BEFORE YOU BEGIN

Determine which devices you want to include in the configuration delivery job. Any managed device can be included in the job.

DETAILED STEPS


Step 1 From the Feature Selector pane, choose Configuration Change Management > Configuration Delivery Management.

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

Step 2 Click the configuration delivery job whose destination devices you want to configure.

The Details pane shows the Configuration section for the job that you selected.

Step 3 On the Details tab, expand the Configuration section, as needed.

The Selected Devices area shows the destination devices that are currently included in the job.

Step 4 (Optional) If you want to add one or more devices to the job, do the following:

a. Under Device Configuration, click Add Devices.

The Device Selection dialog box appears.

b. (Optional) Use the "Show devices grouped by" options to organize the devices shown in the Available Devices list. You can group devices in one of the following ways:

Device Group—Groups devices by the device groups that they are assigned to in the Device Group feature.

Platform type—Groups devices by device type.

None—Shows every discovered device.

c. Move one or more devices from the Available Devices List to the Selected Devices list.

To move one device, click the device and then click Add.

To move more than one device, press and hold Ctrl, click each device, and then click Add.


Note To remove a device from the Selected Devices list, click the device and then click Remove.


d. Click OK.

Step 5 (Optional) If you want to remove devices from the Selected Devices area, do the following:

a. Click a device to select it. If you want to select more than one device, press and hold Ctrl and then click each device that you want to select.

b. Under Device Configuration, click Delete Device.

The devices are removed from the Selected Devices area.

Step 6 From the menu bar, choose File > Deploy to save the configuration delivery job to the Cisco DCNM server.


Configuring Cisco IOS and Cisco NX-OS Commands for a Device Command Interface Job

For a device command interface job, you must manually configure the Cisco IOS and the Cisco NX-OS commands to be sent to destination devices.

BEFORE YOU BEGIN

Ensure that the configuration delivery job exists in Cisco DCNM.

Ensure that the job is configured with the desired destination devices.

Consider using a text editor to write and edit the Cisco IOS and the Cisco NX-OS commands that you want to include in the job.

If the commands that you want to specify are currently configured on a Cisco IOS or a Cisco NX-OS device in your data center, consider copying the relevant portion of the running configuration from that device as the basis for the manually specified commands for the job.


Note All configuration delivery jobs begin in the global configuration command mode. You must consider the command mode when you enter 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.


DETAILED STEPS


Step 1 From the Feature Selector pane, choose Configuration Change Management > Configuration Delivery Management.

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

Step 2 Click the configuration delivery job whose Cisco IOS or the Cisco NX-OS commands you want to configure.


Tip If a job is a manual configuration delivery job, the Source column in the Summary pane shows "Manual."


The Details pane shows the Configuration section for the job that you selected.

Step 3 On the Details tab, expand the Configuration section, as needed.

The Selected Devices area shows the destination devices that are currently included in the job.

Step 4 For each destination device, enter configuration commands, as follows:

a. Under Selected Devices, click the device for which you want to enter configuration commands.

b. Under Configuration Commands, enter the configuration commands. Place each command on a separate line. You can paste command text into the Cisco DCNM client.


Tip To copy the configuration commands that you specified to another device, click the Copy Config Commands icon, click the other device under Selected Devices, and then click the Paste Config Commands icon.


Step 5 From the menu bar, choose File > Deploy to save your changes to the Cisco DCNM server.


Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Expert Job

For a configuration expert job, you can specify which commands from the device source should be delivered to the destination devices.

BEFORE YOU BEGIN

Ensure that the configuration delivery job exists in Cisco DCNM.

Ensure that the job is configured with the desired destination devices.

Ensure that the source device is configured with the commands that you want to use in the job.


Note All configuration delivery jobs begin in the global configuration command mode. You must consider the command mode when you specify 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.


DETAILED STEPS


Step 1 From the Feature Selector pane, choose Configuration Change Management > Configuration Delivery Management.

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

Step 2 Click the configuration delivery job whose Cisco IOS or the Cisco NX-OS commands you want to configure.


Tip If a job is a device-source delivery job, the Source column in the Summary pane shows the IP address of the source device.


The Details pane shows the Configuration section for the job that you selected.

Step 3 On the Details tab, expand the Configuration section, as needed.

The Selected Devices area shows the destination devices that are currently included in the job.

Step 4 From the Source list, choose the IP address of the device from which you want Cisco DCNM to retrieve the Cisco IOS or the Cisco NX-OS commands.

Step 5 Retrieve commands from the source device, as follows:

a. In the Command field, enter the show command to retrieve the Cisco IOS or the Cisco NX-OS commands that you want to include in the configuration delivery job.

For example, if you want to retrieve Border Gateway Protocol (BGP) commands from the running configuration on a Cisco Nexus 7000 Series switch, you could enter the show running-configuration bgp command.

b. (Optional) If you want to filter the output of the show command, click the double down arrow button to the right of the Command field, enter filters as needed, and click OK.

For example, you can use the Output Filter field to specify a grep filter keyword to limit the output to commands that include a specific text string. You can use the begin filter keyword to exclude output before the first line that contains a specific text string.

c. Click Fetch.

The output of the show command appears in the Config Commands Tree area. The tree lists the commands by the command-mode hierarchy. For example, commands for a particular Ethernet interface command are shown nested below the applicable interface command.

d. Verify that all the commands that you need to include in the job are in the Config Command Tree. If not, repeat Step 5.

Step 6 For each destination device, specify the commands to be included in the delivery job, as follows:

a. Under Selected Devices, click the device.

b. Under Configuration Commands Tree, check the check box to the left of each command that you want to include in the job.

To include all the commands nested under a command that is listed at a higher level, you can check the check box for the higher-level command.

To filter the commands in the Config Commands Tree, click the Show Filter Options icon and uncheck the check box for commands that you want to hide in the Config Commands Tree.

To copy the configuration commands that you specified to another device, click the Copy Config Commands icon, click the other device under Selected Devices, and then click the Paste Config Commands icon.

c. If you want to modify the included configuration commands, click the Show/Hide Config Commands Tree icon to hide the tree, click in the Configuration Commands field, and enter the changes to commands.

Step 7 From the menu bar, choose File > Deploy to save your changes to the Cisco DCNM server.


Configuring the Cisco IOS and Cisco NX-OS Commands for a Configuration Template Center

For a configuration template center, you can specify the template to be used and each instance of the template.

BEFORE YOU BEGIN

Ensure that the configuration delivery job exists in Cisco DCNM.

Ensure that the job is configured with the desired destination devices.

DETAILED STEPS


Step 1 From the Feature Selector pane, choose Configuration Change Management > Configuration Delivery Management.

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

Step 2 Click the configuration delivery job whose Cisco IOS or the Cisco NX-OS commands you want to configure.


Tip If a job is a manual configuration delivery job, the Source column in the Summary pane shows the name of the template specified in the job.


The Details pane shows the Configuration section for the job that you selected.

Step 3 On the Details tab, expand the Configuration section, as needed.

The Selected Devices area shows the destination devices that are currently included in the job.

Step 4 Under Select Template, expand the Templates list, as needed.

Step 5 Click the radio button for the template that you want to use.

The Cisco IOS or the Cisco NX-OS commands in the template appear under Configuration Commands. Parameters in the commands appear in the format $$parameter$$.


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


Under Template Parameters, a column appears for each parameter in the template. Column names correspond to the parameter names.

Step 6 Under Configuration Commands, read the commands to ensure that you have selected the correct template. If you need to select a different template, return to Step 5.

Step 7 For each destination device, configure one or more template rows, as follows:

a. Under Selected Devices, click the device.

b. Right-click below the column names under Template Parameters and choose Add Template Row.

c. For each column under Template Parameters, double-click the entry for the new template row and enter the parameter value.

The parameter value that you specify should be Cisco IOS or Cisco NX-OS keywords and arguments that result in a valid command. For example, if the template includes the interface command and a parameter for all keywords after the command name, you must specify the interface type and port identifier. If the destination device is a Cisco Nexus 7000 Series switch and you wanted to specify Ethernet interface in slot 1, port 4, the parameter value should include "Ethernet 1/4".

As you enter parameter values, the Configuration Commands area shows the Cisco IOS or the Cisco NX-OS commands with the parameter values inserted.

d. Review the commands in the Configuration Commands area to ensure that you have specified a value for all parameters. Make changes as needed.

e. If you want to add more instances of the template to the selected destination device, return to Step b.


Tip To copy the configuration commands that you specified to another device, click the Copy Config Commands icon, click the other device under Selected Devices, and then click the Paste Config Commands icon.


Step 8 From the menu bar, choose File > Deploy to save your changes to the Cisco DCNM server.


Adding a Template (ASCII Text Files)

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 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.

DETAILED STEPS


Step 1 From the Features Selector pane, choose Configuration Change Management > Configuration Template Center.

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

Step 2 From the menu bar, choose Actions > Create Template.

A row for the new template appears in the Summary pane.

Step 3 In the row for the new template, enter a name and description for the template.

Step 4 In the Details pane, create the template file by entering commands in the pane of the Details tab. Ensure that the new template meets template requirements and that it includes the configuration commands that you need.


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, the template becomes permanent and cannot be deleted.


Step 5 In the Details pane, click the Check for Errors icon 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 From the menu bar, choose File > Deploy to save your changes to the Cisco DCNM server.


Changing a 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.

DETAILED STEPS


Step 1 From the Features Selector pane, choose Configuration Change Management > Configuration Template Center.

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

Step 2 In the Contents pane, select the template you want to change.

Step 3 In the Details pane, change the template file by editing the commands. Ensure that the edited template meets template requirements.


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.


Step 4 In the Details pane, click the Check for Errors icon 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 5 From the menu bar, choose File > Deploy to save your changes to the Cisco DCNM server.


Removing a 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 Configuration Change Management > Configuration Template Center.

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

Step 2 In the Content pane, select the template you want to delete.

Step 3 From the menu bar, choose Actions > Delete Template.

Step 4 In the menu bar, refresh the Cisco DCNM by clicking View > Refresh.


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:

set JAVA_HOME=INSTALL_DIR\dcm\java\jre1.6
 
   

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

set JAVA_HOME=C:\Program Files\Cisco Systems\dcm\java\jre1.61
 
   

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

set JAVA_HOME=/usr/local/cisco/dcm/java/jre1.6 

Step 4 Enter the following command:

twiddle_script -s IP_address:naming_service_port invoke 
"com.cisco.dcbu.dcm:service=ConfigDeliveryService" populateTemplates
 
   

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:

twiddle.bat -s 10.0.0.0:1099 invoke "com.cisco.dcbu.dcm:service=ConfigDeliveryService" 
populateTemplates
 
   

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:

twiddle.sh -s 10.0.0.0:1099 invoke "com.cisco.dcbu.dcm:service=ConfigDeliveryService" 
populateTemplates
 
   

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 Configuration Change Management > Configuration Delivery Management.

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

Step 2 Click the configuration delivery job whose destination devices you want to configure.

The Details pane shows the Configuration Delivery Options section for the job that you selected.

Step 3 On the Details tab, expand the Configuration Delivery Options section, as needed.

Step 4 (Optional) Configure the transaction options, as follows:

a. If you want to use the Cisco IOS or the Cisco NX-OS configuration rollback feature if errors occur when the configuration job runs, under Transaction Options, check Enable Rollback and then choose the radio button for the rollback option that you want Cisco DCNM to use to recover from a configuration failure on a device that is included in the job.

b. If you do not want to use the Cisco IOS or the Cisco NX-OS configuration rollback feature, under Transaction Options, uncheck Enable Rollback and then choose the radio button for the option that describes the option that you want Cisco DCNM to use to recover from a configuration failure on a device that is included in the job.

Step 5 (Optional) If you added more than one device to the configuration delivery job, under Delivery Order, choose the option that you want: sequential or parallel delivery of configuration commands.

Step 6 (Optional) If you want to copy the running configuration to the startup configuration, under Post Delivery Options, choose Copy run to start.

Step 7 From the menu bar, choose File > Deploy to save the configuration delivery job to the Cisco DCNM server.


Scheduling a Configuration Delivery Job

You can add a date and time that Cisco DCNM should run a configuration delivery job.

If you have previously scheduled a job and the scheduled time has not passed, you can change or remove the schedule of the job.

BEFORE YOU BEGIN

Ensure that the configuration delivery job exists in Cisco DCNM. If you are changing a previously specified schedule for a job, you can do so only if Cisco DCNM has not yet run the job.

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

DETAILED STEPS


Step 1 From the Feature Selector pane, choose Configuration Change Management > Configuration Delivery Management.

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

Step 2 Click the configuration delivery job that you want to schedule.

The Details pane shows the Configuration section for the job that you selected.

Step 3 In the Scheduled At column, double-click the entry for the selected job.

The scheduling dialog box appears. If the job had no schedule previously, the current date and time are shown in the dialog box.

The dialog box shows a calendar for specifying the date and a 24-hour clock for specifying the time.

Step 4 To schedule the job, do one of the following:

If you want to run the job immediately, click Now and then click OK.

If you want to specify a future date and time, use the calendar to specify the date and the clock to specify the time, and then click OK.

If you want to remove the schedule, click None and then click OK.

Step 5 From the menu bar, choose File > Deploy to save your changes to the Cisco DCNM server.


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 Configuration Change Management > Configuration Delivery Management.

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

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

The Details pane shows the Configuration Delivery Options section for the job that you selected.

Step 3 From the menu bar, choose Actions > Delete Configuration Delivery Task.

A confirmation dialog box appears.

Step 4 Click Yes.

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


Field Descriptions for Configuration Delivery Management

This section includes the following field descriptions for the Configuration Delivery Management feature:

Delivery Job: Details: Configuration Section

Delivery Job: Details: Configuration Delivery Options Section

Configuration Delivery for Templates: Virtual Port Channel Template

Configuration Delivery for Templates: FIP Snooping Template

Configuration Delivery for Templates: FCoE Template

Delivery Job: Details: Configuration Section

Table 9-4 Delivery Job: Details: Configuration Section 

Field
Description

Comment

Description of the delivery job. By default, the description reflects the job source, as follows:

Template Flow—Default comment for a template-source job.

Device Flow—Default comment for a device-source job.

Manual Flow—Default comment for a manual-source job.

Portprofile Flow—Default comment for a job initiated from the Port Profiles feature.

Source

Device-source and port profile-source jobs only. IP address of the device used as the source for the configuration delivery job. For port profile-source jobs, this field cannot be configured.

Command

Device-source and port profile-source jobs only. Cisco IOS or the Cisco NX-OS show command used to retrieve the configuration commands from the source device. For port profile-source jobs, this field cannot be configured.

Selected Devices

Destination devices for the configuration delivery job. By default, no destination devices are selected.

Template Parameters

Template-source jobs only. Shows one row for each template instance that you add for the highlighted device in the Selected Devices list. Each row includes a configurable field for each parameter in the template. Parameter names appear as column labels. By default, the Template Parameters field contains no template instances.

Show Template Parameter Names in preview

Template-source jobs only. Specifies whether the Configuration Commands field shows parameter names. Checking this check box can help you identify the effect of specifying a parameter value. For example, if this check box is checked, a template included a SPEED parameter for use with the Cisco NX-OS command speed, and you specified "auto" for the value of the SPEED parameter, the Configuration Commands field would show the following:

speed $$SPEED$$=auto
 
        

For the same example, if the check box is unchecked, the Configuration Commands field would show the following:

speed auto
 
        

By default, this check box is unchecked.

Templates

Template-source jobs only. Lists the configuration templates available on the Cisco DCNM server. You can select only one template for a configuration delivery job. The commands included in the selected template appear in the Configuration Commands field.

Config Commands Tree

Device-source jobs only. Shows the Cisco IOS or the Cisco NX-OS commands retrieved from the source device when you click Fetch. The commands appear in a tree layout that reflects the command modes in the Cisco IOS or the Cisco NX-OS CLI. The selected commands appear in the Configuration Commands field.

Configuration Commands

Cisco IOS or the Cisco NX-OS configuration commands included in the configuration delivery job, depending upon the job source, as follows:

Template-source jobs—Shows the commands included in the template instance highlighted in the Templates field. You can control whether parameter names appear by using the Show Template Parameter Names in preview check box.

Device-source jobs—Shows the commands selected in the Config Commands Tree field and any modifications that you made after selecting the commands.

Port profile-source jobs—Shows the commands received from the port profile that you used to create the job.

Manual-source jobs—Shows the commands that you type or paste into the field.


Delivery Job: Details: Configuration Delivery Options Section

Table 9-5 Delivery Job: Details: Configuration Delivery Options Section 

Field
Description
Transaction Options

Enable Rollback

Specifies whether Cisco DCNM uses the Cisco IOS or the Cisco NX-OS rollback feature to recover from failures on devices during configuration delivery. By default, this check box is unchecked.

Note Cisco DCNM can perform a rollback only on devices that support a configuration rollback, such as Cisco Nexus 7000 Series devices.

Stop configuration to a device on any failure in that device

Specifies that the delivery job should stop only on the device on which the failure occurred. If there are other devices in the delivery job, the job continues on devices that did not have a failure.

This field appears when the Enable Rollback check box is unchecked.

Stop configuration to all devices on any failure in any device

Specifies that the delivery job should stop for all devices included in the job if a failure occurs on any device.

This field appears when the Enable Rollback check box is unchecked.

Continue configuration on any failure in any device

Specifies that the delivery job continues regardless of failures.

This field appears when the Enable Rollback check box is unchecked.

Rollback the configuration on the device if there is any failure in that device

Specifies that Cisco DCNM should roll back the running configuration of the device that had the failure to the previous running configuration. If there are other devices in the delivery job, the job continues on devices that did not have a failure.

This field appears when the Enable Rollback check box is checked.

Rollback the configuration in all the selected devices if there is any failure in any device

Specifies that Cisco DCNM should roll back the running configuration of all devices included in the job if a failure occurs on a device. This option is particularly useful if the job is configured for parallel delivery.

This field appears when the Enable Rollback check box is checked.

Rollback the configuration on the device, if there is any failure in that device and stop further configuration delivery to the remaining devices

Specifies that Cisco DCNM should roll back the running configuration of the device that had the failure and should not continue to deliver the job to devices that have not received the configuration yet. This option is particularly useful if the job is configured for sequential delivery.

This field appears when the Enable Rollback check box is checked.

Delivery Order

Deliver configuration to one device at a time in sequence

Specifies that Cisco DCNM delivers the configuration to devices included in the job in a serial delivery. This option is particularly helpful if you have configured the job to stop after the first failure.

Deliver configuration to all devices in parallel at the same time

Specifies that Cisco DCNM delivers the configuration to all devices included in the job in parallel. This option delivers the configuration to the devices in the job faster than serial delivery.

Post Delivery Options

Copy run to start

Specifies that Cisco DCNM copy the running configuration to the startup configuration. By default, this checkbox is unchecked.


Configuration Delivery for Templates: Virtual Port Channel Template

Table 9-6 Peer-Link Access Port Channel Template 

Field
Description

DOMAIN_ID

vPC Domain ID

ACC_VLAN

Access VLAN ID

PO_NO

Port channel ID

SRC_IP

Peer keepalive source IP address

DEST_IP

Peer keepalive destination IP address

VRF

Name of the VRF

INTF_MODE

Link Aggregation Protocol mode

INTF_NAME_RANGE

Range of valid member ports of the port channel


Table 9-7 Peer-Link Trunk Port Channel Template

Field
Description

DOMAIN_ID

vPC Domain ID

ALL_VLAN

Range of VLANs that are allowed on the port channel

NAT_VLAN

ID of the native VLAN

PO_NO

Port channel ID

SRC_IP

Peer keepalive source IP address

DEST_IP

Peer keepalive destination IP address

VRF

Name of the VRF

INTF_MODE

Link Aggregation Protocol mode

INTF_NAME_RANGE

Range of valid member ports of the port channel


Table 9-8 Virtual Access Port Channel Template  

Field
Description

vPC_ID

vPC ID

PO_NO

IP address of the port channel

ACC_VLAN

Access VLAN ID

INTF_NAME_RANGE

Range of valid port channels of the member ports

INTF_MODE

Link Aggregation Protocol mode


Table 9-9 Virtual Trunk Port Channel Template

Field
Description

vPC_ ID

vPC ID

PO_NO

IP address of the port channel

ALL_VLAN

Range of VLAN allowed on the port channel

NAT_VLAN

ID of the native VLAN

INTF_RANGE

Range of valid port channels of the member ports

INTF_MODE

Link Aggregation Protocol mode


Configuration Delivery for Templates: FIP Snooping Template

Table 9-10 FIP Snooping Template

Field
Description

VLAN_RANGE

Valid VLAN range

ENODE_INTERFACE_RANGE

Valid values for the ENODE interface range

FCF_INTERFACE_RANGE

Valid values for the FCF interface range

FC_MAP

Value of FC mapping


Configuration Delivery for Templates: FCoE Template

Table 9-11 FCoE Template

Field
Description

VLAN_ID

ID for the VLAN

VSAN_ID

ID for the VSAN

FC_MAP

Value of FC mapping

VFC_NUMBER_RANGE

Valid range for the VFC


Additional References

For additional information related to configuration delivery management, see the following sections:

Related Documents

Standards

Related Documents

Related Topic
Document Title

Port profiles

Cisco Nexus 7000 Series NX-OS Interfaces Configuration Guide, Release 5.x

Configuration rollback in Cisco NX-OS

Cisco Nexus 7000 Series NX-OS System Management Configuration Guide, Release 5.x


Standards

Standards
Title

No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.


Feature History for Configuration Delivery Management

Table 9-12 lists the release history for this feature.

Table 9-12 Feature History for Configuration Delivery Management 

Feature Name
Releases
Feature Information

Configuration Delivery Management

5.2(1)

Configuration delivery templates are supported on the Cisco IOS and the Cisco NX-OS platforms.

Configuration Delivery Management

5.1(1)

Configuration delivery templates are supported in the Cisco DCNM client.

Configuration Delivery Management

5.0(2)

This feature was introduced.