Templates

The following table provides an overview of the significant changes up to this current release. The table does not provide an exhaustive list of all changes nor of the new features up to this release.

Templates UI Navigation

You can add, edit, or delete templates that are configured across different Cisco Nexus, IOS-XE, IOS-XR, and Cisco MDS platforms using Cisco Nexus Dashboard Fabric Controller Web client. The following parameters are displayed for each template that is configured on Cisco Nexus Dashboard Fabric Controller Web client. Templates support JavaScript. You can use the JavaScript function in a template to perform arithmetic operations and string manipulations in the template syntax.

Click the table header to sort the entries in alphabetical order of that parameter.

Templates with errors are not listed in the Templates window. You cannot import templates with errors. To import such templates, fix the errors, and import them. The following table describes the action items, in the Actions drop-down list, that appears in the Templates window.

Table 2. Templates Actions and Description

Actions	Description
Create new template	Allows you to create a new template. For more information, see Creating a New Template.
Edit template properties	Allows you to edit the template properties. You can edit only one template at a time. For more information, see Editing a Template.
Edit template content	Allows you to edit the template content. You can edit only one template at a time. For more information, see Editing a Template.
Duplicate template	Allows you to duplicate the selected template with a different name. You can edit the template as required. You can duplicate only one template at a time.To duplicate a template, select the check box next to the template that you want to duplicate and choose Duplicate template. The Duplicate Template window appears. Specify a name for the duplicated template. For more information about editing the duplicated template, see Editing a Template.
Delete template	Allows you to delete a template. You can delete more than one template in a single instance.You can delete the user-defined templates. However, you cannot delete the predefined templatesTo delete a template, select the check box next to the template that you want to delete and choose Delete template. A warning message appears. If you are sure you want to delete the template, click Confirm. If not, click Cancel. If the template is in use or is a shipping template, you cannot delete it, and an error message appears.NOTE: Select multiple templates to delete them at the same instance. To delete the template permanently, delete the template that is located in your local directory: Cisco Systems\dcn\ndfc\data\templates\.
Import	Allows you to import a template from your local directory, one at a time. For more information, see Importing a Template.
Import as Zip	Allows you to import .zip file, that contains more than one template that is bundled in a .zip format All the templates in the ZIP file are extracted and listed in the table as individual templates. For more information, see Importing a Template To install POAP templates for the Nexus Dashboard Fabric Controller Virtual Appliance (OVA or ISO), see Installing POAP Templates.
Export	Allows you to export the template configuration to a local directory location. You can export only one template at a time.To export a template, use the check box next to it to select it and choose Export. Select a location on your local system directory to store the template file. Click Save. The template file is exported to your local directory.

You can only view templates with the network-operator role. You cannot create, edit, or save templates with this role. However, you can create or edit templates with the network-stager role.

Cisco Nexus Dashboard Fabric Controller UI Navigation

To create user-defined templates and schedule jobs from the Cisco Nexus Dashboard Fabric Controller Web UI, perform the following steps:

Cisco Nexus Dashboard Fabric Controller UI Navigation

You can edit the user-defined templates. However, the predefined templates and templates that are already published cannot be edited.

Use the Edit Template window to first edit the template properties and then edit the template content. Furthermore, you can edit either only the template properties using the Edit template properties action or only the template content using the Edit template content action. In other words, you can edit the template properties at one instance, and then, edit the template content at another instance. You can also use this window to view the template properties and content.

Perform the following steps to edit the template properties and then edit the template content:

UI Navigation

Follow the same procedure while importing zipped templates.

To import a template from the Cisco Nexus Dashboard Fabric Controller Web UI, perform the following steps:

UI Navigation

Cisco Nexus Dashboard Fabric Controller allows you to add, edit, or delete user-defined templates that are configured across different Cisco Nexus platforms. From Cisco Nexus Dashboard Fabric Controller release 10.0(x), Cisco-defined FabricPath and IP VXLAN Programmable Fabric POAP Templates are provided as a separate download on the official Cisco website. These templates are compatible for use with the Nexus Dashboard Fabric Controller Virtual Appliance (OVA or ISO) for use with Nexus 2000, Nexus 5000, Nexus 6000, Nexus 7000, and Nexus 9000 Series switches.

You can download the Cisco-defined templates from https://software.cisco.com/download/release.html.

Perform the following task to install the POAP templates from the Cisco Nexus Dashboard Fabric Controller.

The configuration template content mainly consists of four parts. Click the Help icon next to the Template Content for information about editing the content of the template.

Example: running-config, startup-config

Example: 10.1,50.01

Example: 1-10,15,18,20

Example: eth1/1, fa10/1/2 etc.

Example: eth10/1/20-25, eth11/1-5

Example 1: 172.22.31.97,
           172.22.31.99,
           172.22.31.105,
           172.22.31.109
Example 2: 2001:0db8:85a3:0000:0000:8a2e:0370:7334,
           2001:0db8:85a3:0000:0000:8a2e:0370:7335,
           2001:0db8:85a3:1230:0000:8a2f:0370:7334
Example 3: 172.22.31.97, 172.22.31.99,
           2001:0db8:85a3:0000:0000:8a2e:0370:7334,
           172.22.31.254

Example: 192.168.1.1

Example: 1:2:3:4:5:6:7:8

Example: 192.168.1.1/24

Example: 1:2:3:4:5:6:7:8

22

Example: 49.0001.00a0.c96b.c490.00

Example: 100

Example:
string scheduledTime
{
    regularExpr=^([01]\d|2[0-3]):([0-5]\d)$;
}

Example: {a,b,c,str1,str2}

struct <structure name declaration > {
<parameter type> <parameter 1>;
<parameter type> <parameter 2>;
.....
} [<structure_inst1>] [, <structure_inst2>] [, <structure_array_inst3 []>];


struct interface_detail {
	string inf_name;
	string inf_description;
	ipAddress inf_host;
	enum duplex {
		validValues = auto, full, half;
	};
}myInterface, myInterfaceArray[];

Example: 20:01:00:08:02:11:05:03

##template variables
integer VSAN_ID;
string SLOT_NUMBER;
integerRange PORT_RANGE;
integer VFC_PREFIX;
##

Example: true

Example: 75.56, -8.5

Example: 50.5 - 54.75

Example: 50, -75

Example: 50-65

Example: Ethernet 5/10

Example 1: 172.22.31.97, 172.22.31.99, 172.22.31.105, 172.22.31.109
Example 2: 2001:0db8:85a3:0000:0000:8a2e:0370:7334, 2001:0db8:85a3:0000:0000:8a2e:0370:7335,
2001:0db8:85a3:1230:0000:8a2f:0370:7334
Example 3: 172.22.31.97, 172.22.31.99, 2001:0db8:85a3:0000:0000:8a2e:0370:7334, 172.22.31.254

Example: 49.0001.00a0.c96b.c490.00

Example: 100

Example for string Regular expression:
string scheduledTime
{
    regularExpr=^([01]\d|2[0-3]):([0-5]\d)$;
}

Example: {string1, string2}

struct <structure name declaration > {
<parameter type> <parameter 1>;
<parameter type> <parameter 2>;
.....
} [<structure_inst1>] [, <structure_inst2>] [, <structure_array_inst3 []>];

Example: true

Example: 75.56, -8.5

Example: 50.5 - 54.75

Example: 50, -75

Example: 50-65

Example: Ethernet 5/10

Example 1: 172.22.31.97, 172.22.31.99, 172.22.31.105, 172.22.31.109
Example 2: 2001:0db8:85a3:0000:0000:8a2e:0370:7334, 2001:0db8:85a3:0000:0000:8a2e:0370:7335,
2001:0db8:85a3:1230:0000:8a2f:0370:7334
Example 3: 172.22.31.97, 172.22.31.99, 2001:0db8:85a3:0000:0000:8a2e:0370:7334, 172.22.31.254

Example: 49.0001.00a0.c96b.c490.00

Example: 100

Example for string Regular expression:
string scheduledTime
{
    regularExpr=^([01]\d|2[0-3]):([0-5]\d)$;
}

Example: {string1, string2}

struct <structure name declaration > {
<parameter type> <parameter 1>;
<parameter type> <parameter 2>;
.....
} [<structure_inst1>] [, <structure_inst2>] [, <structure_array_inst3 []>];

##template variables

integer VLAN_ID {
min = 100;
max= 200;
};

string USER_NAME {
defaultValue = admin123;
minLength = 5;
};

struct interface_a{
	string inf_name;
	string inf_description;
	ipAddress inf_host;
	enum duplex {
		validValues = auto, full, half;
	};
}myInterface;

##

Variable Annotation

You can configure the variable properties marking the variables using annotations.

---

Variable Annotations are available for POAP only. However, the annotations do not impact on the template type "CLI". The following annotations can be used in the template variable section.

---

Annotation Key	Valid Values	Description
AutoPopulate	Text	Copies values from one field to another
DataDepend	Text
Description	Text	Description of the field appearing in the window
DisplayName	Text Enclose the text with quotes, if there is space.	Display name of the field appearing in the window
Enum	Text1, Text2, Text3, and so on	Lists the text or numeric values to select from
IsAlphaNumeric	"true" or "false"	Validates if the string is alphanumeric
IsAsn	"true" or "false"
IsDestinationDevice	"true" or "false"
IsDestinationFabric	"true" or "false"
IsDestinationInterface	"true" or "false"
IsDestinationSwitchName	"true" or "false"
IsDeviceID	"true" or "false"
IsDot1qId	"true" or "false"
IsFEXID	"true" or "false"
IsGateway	"true" or "false"	Validates if the IP address is a gateway
IsInternal	"true" or "false"	Makes the fields internal and does not display them on the window Use this annotation only for the ipAddress variable.
IsManagementIP	"true" or "false" This annotation must be marked only for variable "ipAddress".
IsMandatory	"true" or "false"	Validates if a value should be passed to the field mandatorily
IsMTU	"true" or "false"
IsMultiCastGroupAddress	"true" or "false"
IsMultiLineString	"true" or "false"	Converts a string field to multiline string text area
IsMultiplicity	"true" or "false"
IsPassword	"true" or "false"
IsPositive	"true" or "false"	Checks if the value is positive
IsReplicationMode	"true" or "false"
IsShow	"true" or "false"	Displays or hides a field on the window
IsSiteId	"true" or "false"
IsSourceDevice	"true" or "false"
IsSourceFabric	"true" or "false"
IsSourceInterface	"true" or "false"
IsSourceSwitchName	"true" or "false"
IsSwitchName	"true" or "false"
IsRMID	"true" or "false"
IsVPCDomainID	"true" or "false"
IsVPCID	"true" or "false"
IsVPCPeerLinkPort	"true" or "false"
IsVPCPeerLinkPortChannel	"true" or "false"
IsVPCPortChannel	"true" or "false"
Password	Text	Validates the password field
UsePool	"true" or "false"
UseDNSReverseLookup
Username	Text	Displays the username field on the window
Warning	Text	Provides text to override the Description annotation

Example: AutoPopulate Annotation

##template variables
string BGP_AS;
 @(AutoPopulate="BGP_AS")
  string SITE_ID;
##

Example: DisplayName Annotation

##template variables
@(DisplayName="Host Name", Description = "Description of the host")
String hostname;
@(DisplayName="Host Address", Description = " test description" IsManagementIP=true)
ipAddress hostAddress;
##

Example: IsMandatory Annotation

##template variables
@(IsMandatory="ipv6!=null")
ipV4Address ipv4;
@(IsMandatory="ipv4!=null")
ipV6Address ipv6;
##

Example: IsMultiLineString Annotation

##template variables
@(IsMultiLineString=true)
string EXTRA_CONF_SPINE;
##

IsShow Annotation

Example 1##template variables
boolean isVlan;
@(IsShow="isVlan==true")
integer vlanNo;
##

Example 2##template variables
boolean enableScheduledBackup;
@(IsShow="enableScheduledBackup==true",Description="Server time")
string scheduledTime;
##
The condition "enableScheduledBackup==true" evaluates to true/false

Example 3##template variables
@(Enum="Manual,Back2BackOnly,ToExternalOnly,Both")
string VRF_LITE_AUTOCONFIG;
@(IsShow="VRF_LITE_AUTOCONFIG!=Manual",  Description="Target Mask")
integer DCI_SUBNET_TARGET_MASK
##
The condition "VRF_LITE_AUTOCONFIG!=Manual" matches string comparison to evaluate to true or false

Example: Warning Annotation

##template variables
@(Warning="This is a warning msg")
  string SITE_ID;
##

Templates Content

This section includes the configuration commands and any parameters that you want to include in the template. These commands can include the variables declared in the template variables section. During the command generation process the variable values are substituted appropriately in the template content.

---

You must specify the commands that you include as if you were entering them in the global configuration command mode on any device. You must consider the command mode when you include commands.

---

Template content is governed by the usage of variables.

• Scalar variables: does not take a range or array of values which cannot be used for iteration (In the variable types table those marked iterate-able as 'No'). Scalar variables must be defined inside the template content.

  Syntax: $$<variable name>$$
  Example: $$USER_NAME$$

• Iterative variables: used for block iteration. These loop variable must be accessed as shown below inside the iteration block.

  Syntax:@<loop variable>
  Example:
  foreach val in $$INTEGER_RANGE_VALUE$$ {
  @val
  }

• Scalar Structure Variable: Structure member variables can be accessed inside the template content.

  Syntax: $$<structure instance name>.<member variable name>$$
  Example: $$myInterface.inf_name$$

• Array Structure Variable: Structure member variables can be accessed inside the template content.

  Syntax: $$<structure instance name>.<member variable name>$$
  Example: $$myInterface.inf_name$$

In addition to the template variables, you can use the conditional and iterative command generation using the following statements:

• if-else if-else Statement: makes a logical decision in inclusion/exclusion of set of configuration command based on the value assigned for the variable in it.

  Syntax: if(<operand 1>  <logical operator>  <operand 2>){
  command1 ..
  command2..
  ..
  }
  else  if (<operand 3> <logical operator> <operand 4> )
  {
  Command3 ..
  Command4..
  ..
  }
  else
  {
  Command5 ..
  Command6..
  ..
  }
  Example: if-else if-else statement
  if($$USER_NAME$$ == 'admin'){
  Interface2/10
  no shut
  }
  else {
  Interface2/10
  shut
  }

• foreach Statement: used for iterating a block of commands. The iteration is performed based on the assigned loop variable value.

  Syntax:
  foreach <loop index variable> in $$<loop variable>$$ {
  @<loop index variable> ..
  }
  Example: foreach Statement
  foreach ports in $$MY_INF_RANGE$${
  interface @ports
  no shut
  }

• Optional parameters: By default all parameters are mandatory. To make a parameter optional, you must annotate the parameter.

In the variable section, you can include the following command:

• @(IsMandatory=false)

• Integerfrequency;

  In the template content section, a command can be excluded or included without using "if" condition check, by assigning a value to the parameter. The optional command can be framed as below:

• probeicmp[frequencyfrequency-value][timeoutseconds][retry-countretry-count-value]

Example: Template with assignment operation
##template properties
name =vlan creation;
userDefined= true;
supportedPlatforms = All;
templateType = CLI;
published = false;
##
##template variables
integerRange vlan_range;
@(internal=true)
integer vlanName;
##
##template content
foreach vlanID in $$vlan_range$${
vlan @vlanID
$$vlanName$$=@vlanID
name myvlan$$vlanName$$
}
##

Report Template

The template type of REPORT template is python, and it has two subtypes, UPGRADE and GENERIC.

UPGRADE

The UPGRADE template is used for pre-ISSU and post-ISSU scenarios. These templates are listed in the ISSU wizard.

Refer to the default upgrade template packaged in Nexus Dashboard Fabric Controller for more information on pre-ISSU and post-ISSU handling. The default upgrade template is issu_vpc_check.

---

In order to execute any ISSU operations, any new NDFC user must first set the necessary device credentials under the Credential Management page. You will not be able to execute ISSU operations without first setting the proper device credentials.

---

GENERIC

The GENERIC template is used for any generic reporting scenarios, such as, collecting information about resources, switch inventory, SFPs, and NVE VNI counters. You can also use this template to generate troubleshooting reports.

Resources Report

This report displays information about resource usage for a specific fabric.

The Summary section shows all resource pools with the current usage percentages. Use the horizontal scroll bar at the bottom of the window to display more columns.

POOL NAME: Specifies the name of the pool.

POOL RANGE: Specifies the IP address range of the pool.

SUBNET MASK: Specifies the subnet mask.

MAX ENTRIES: Specifies the maximum number of entries that can be allocated from the pool.

USAGE INSIDE RANGE: Specifies the current number of entries allocated inside the pool range.

USAGE OUTSIDE RANGE: Specifies the current number of entries set outside the pool range.

USAGE PERCENTAGE: This is calculated by using the formula: (Usage Inside Range/Max Entries) *100.

Click View Details to display a view of resources allocated or set in each resource pool. For example, the detailed section for a SUBNET has information about the resources that have been allocated within the subnet.

Switch Inventory Report

This report provides a summary about the switch inventory.

Click View Details to display more information about the modules and licenses.

SFP Report

This report provides information about utilization of SFPs at a fabric and device level.

---

The switch inventory and SFP reports are supported only on Cisco Nexus devices.

---

Troubleshooting Reports

These reports are generated to help in troubleshooting scenarios. Currently, the NVE VNI Counters report is the only pre-defined troubleshooting report. Generating NVE VNI Counters reports involves performing periodic checks to identify the VNIs that are among the top hits based on network traffic. In a large-scale setup, we recommend limiting the report generation frequency to a minimum of 60 minutes.

NVE VNI Counters Report

This report collects the show nve vni counters command output for each VNI in the fabric.

After comparing the oldest report and the newest report, the Summary section shows the top-10 hit VNIs. The top hit VNIs are displayed in these categories:

• L2 or L3 VNIs for unicast traffic

• L2 or L3 VNIs for multicast traffic

• L2 only VNIs for unicast traffic

• L2 only VNIs for multicast traffic

• L3 only VNIs for unicast traffic

• L3 only VNIs for multicast traffic

The oldest report refers to the first report that is saved in the current reporting task. If you want to select a specific report as the first report against which the current report has to be compared, delete all reports that are older than the one selected so that the selected report becomes the first and oldest report.

For example, three reports were run yesterday at 8:00 a.m, 4:00 p.m. and 11:00 p.m. If you want to use the report at 11:00 p.m. as the first and oldest report for today’s reporting, delete the two reports that were run yesterday at 8:00 a.m. and 4:00 p.m.

For a periodic report, the oldest report is the first report that is run at the start time of a period. For daily and weekly reports, the current report is compared against the previously generated report.

The Summary section displays a column-wise report with information about the total transmitted bytes and the VNIs. Use the horizontal scroll bar at the bottom of the window to display more columns.

---

The Summary section in the NVE VNI Counters report displays negative numbers in the TOTAL TX BYTES column if a report is generated after a switch reload or after clearing the counters on the switch. The numbers are displayed correctly in the subsequent reports. As a workaround, we recommend deleting all old reports or creating a new job before reloading switches or clearing counters. Click View Details to display more information. This section shows NVE VNIs and counters on a per-switch basis.

---

For more information on how the reports are displayed, refer Programmable Reports chapter.

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

© 2017-2024 Cisco Systems, Inc. All rights reserved.