Preface

Audience

This publication is intended for experienced network administrators who will configure and maintain the Cisco Application Policy Infrastructure Controller Enterprise Module (Cisco APIC-EM). This guide is part of a documentation set that is designed to help you install, troubleshoot, and upgrade your Cisco APIC-EM. For a complete list of the Cisco APIC-EM documentation set, see Related Documentation.


Note

In this guide, the Cisco Application Policy Infrastructure Controller Enterprise Module (Cisco APIC-EM) is also referred to as the controller.

Document Conventions

This documentation uses the following conventions:

Convention

Description

^ or Ctrl

The ^ and Ctrl symbols represent the Control key. For example, the key combination ^D or Ctrl-D means hold down the Control key while you press the D key. Keys are indicated in capital letters but are not case sensitive.

string

A string is a unquoted set of characters shown in italics. For example, when setting an SNMP community string to public, do not use quotation marks around the string or the string will include the quotation marks.

Command syntax descriptions use the following conventions:

Convention

Description

bold

Bold text indicates commands and keywords that you enter exactly as shown.

italics

Italic text indicates arguments for which you supply values.

[x]

Square brackets enclose an optional element (keyword or argument).

|

A vertical line indicates a choice within an optional or required set of keywords or arguments.

[x | y]

Square brackets enclosing keywords or arguments separated by a vertical line indicate an optional choice.

{x | y}

Braces enclosing keywords or arguments separated by a vertical line indicate a required choice.

Nested sets of square brackets or braces indicate optional or required choices within optional or required elements. For example:

Convention

Description

[x {y | z}]

Braces and a vertical line within square brackets indicate a required choice within an optional element.

Examples use the following conventions:

Convention

Description

screen

Examples of information displayed on the screen are set in Courier font.

bold screen

Examples of text that you must enter are set in Courier bold font.

< >

Angle brackets enclose text that is not printed to the screen, such as passwords.

!

An exclamation point at the beginning of a line indicates a comment line.

[ ]

Square brackets enclose default responses to system prompts.


Caution

Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.


Note

Means reader take note. Notes contain helpful suggestions or references to materials that may not be contained in this manual.

Related Documentation

This section lists the Cisco APIC-EM and related documents available on Cisco.com at the following url:

http://www.cisco.com/c/en/us/support/cloud-systems-management/one-enterprise-network-controller/tsd-products-support-series-home.html

  • Cisco APIC-EM Documentation:

    • Cisco Application Policy Infrastructure Controller Enterprise Module Release Notes

    • Cisco APIC-EM Quick Start Guide (directly accessible from the controller's GUI)

    • Cisco Application Policy Infrastructure Controller Enterprise Module Installation Guide

    • Cisco Application Policy Infrastructure Controller Enterprise Module Upgrade Guide

    • Cisco Application Policy Infrastructure Controller Enterprise Module Administrator Guide

    • Cisco Application Policy Infrastructure Controller Enterprise Module Troubleshooting Guide

    • Open Source Used In Cisco APIC-EM

  • Cisco EasyQoS Application for Cisco APIC-EM

    • Cisco EasyQoS Application for APIC-EM Release Notes

    • Cisco EasyQoS Application for APIC-EM Supported Platforms

    • Cisco EasyQoS Application for APIC-EM User Guide

  • Cisco Network Visibility Application for the Cisco APIC-EM

    • Cisco Network Visibility Application for APIC-EM Release Notes

    • Cisco Network Visibility Application for APIC-EM Supported Platforms

    • Cisco Network Visibility Application for APIC-EM User Guide

  • Cisco Path Trace Application for Cisco APIC-EM

    • Cisco Path Trace Application for APIC-EM Release Notes

    • Cisco Path Trace Application for APIC-EM Supported Platforms

    • Cisco Path Trace Application for APIC-EM User Guide

  • Cisco IWAN Documentation for the Cisco APIC-EM:

    • Release Notes for Cisco IWAN

    • Release Notes for Cisco Intelligent Wide Area Network Application (Cisco IWAN App)

    • Configuration Guide for Cisco IWAN on Cisco APIC-EM

    • Software Configuration Guide for Cisco IWAN on APIC-EM

    • Open Source Used in Cisco IWAN and Cisco Network Plug and Play

  • Cisco Network Plug and Play Documentation for the Cisco APIC-EM:

    • Release Notes for Cisco Network Plug and Play

    • Solution Guide for Cisco Network Plug and Play

    • Configuration Guide for Cisco Network Plug and Play on Cisco APIC-EM

    • Cisco Network Plug and Play Agent Configuration Guide or Cisco Open Plug-n-Play Agent Configuration Guide (depending on the Cisco IOS XE release)

    • Mobile Application User Guide for Cisco Network Plug and Play

  • Cisco Active Advisor Documentation for the Cisco APIC-EM:

    • Cisco Active Advisor for APIC-EM Release Notes

  • Cisco Integrity Verification Documentation for the Cisco APIC-EM:

    • Cisco Integrity Verification Application (Beta) for APIC-EM Release Notes

    • Cisco Integrity Verification Application (Beta) for APIC-EM User Guide

  • Cisco Remote Troubleshooter Documentation for the Cisco APIC-EM:

    • Cisco Remote Troubleshooter Application for APIC-EM Release Notes

    • Cisco Remote Troubleshooter Application for APIC-EM User Guide


Note

For information about developing your own application that interacts with the controller by means of the northbound REST API, see the https://developer.cisco.com/site/apic-em/ Web site.

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation at: http://www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.