Additional documents
For next steps, see....
All related documents are available on the APIC documents landing page. The document names are indicative and will help you to find relevant information about APIC concepts, funtionality and behavior.
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. Learn more about how Cisco is using Inclusive Language.
This chapter contains these sections:
All related documents are available on the APIC documents landing page. The document names are indicative and will help you to find relevant information about APIC concepts, funtionality and behavior.
In several instances, the NX-OS style CLI can create the ACI model constructs implicitly for a user's ease of use, and they also provide validations to ensure consistency in configuration. This functionality reduces and prevents faults.
For further details about configurations and tasks, see the Cisco APIC Basic Configuration Guide and the Cisco APIC NX-OS Style Command-Line Interface Configuration Guide.
Use this procedure to change the BIOS password.
Cisco APIC ships with a default BIOS password. The default password is "password". When the boot process starts, the boot screen displays the BIOS information on the console server.
|
Step 1 |
During the BIOS boot process, when the screen displays Press <F2> Setup, press F2. |
|
Step 2 |
At the Enter Password dialog box, enter the current password. The default password can be password or Insieme123. |
|
Step 3 |
In the Setup Utility, choose the Security tab, and choose Set Administrator Password. |
|
Step 4 |
In the Enter Current Password dialog box, enter the current password. |
|
Step 5 |
In the Create New Password dialog box, enter the new password. |
|
Step 6 |
In the Confirm New Password dialog box, re-enter the new password. |
|
Step 7 |
Choose the Save & Exit tab. |
|
Step 8 |
In the Save & Exit Setup dialog box, choose Yes. |
|
Step 9 |
Wait for the reboot process to complete. |
The centralized management controller for ACI is the Application Policy Infrastructure Controller (APIC). The Application Policy Infrastructure Controller (APIC) is a cluster-based management controller that
serves as the unified point for automation, management, monitoring, and programmability for the ACI. The APIC supports the deployment, management, and monitoring of any application anywhere, with a unified operations model for the physical and virtual components of the infrastructure.
programmatically automates network provisioning and control based on application requirements and policies. It is the central control engine for the broader cloud network. It simplifies management and allows flexibility in how application networks are defined and automated.
provides northbound REST APIs to support integration and custom workflows.
The APIC is a distributed system that is implemented as a cluster of many controller instances.
This section describes how to establish a local serial connection to the Cisco APIC server to begin the initial basic configuration. For additional connection information, including instructions on connecting to the server remotely for setup, refer to "Initial Server Setup" in the Cisco APIC M4/L4 server installation and service guide. If you are on Cisco APIC release 6.1(4), you can refer the Cisco APIC G5 server installation and service guide.
The Cisco APIC server operates on a Cisco Integrated Management Controller (CIMC) platform. You can make an initial connection to the CIMC platform using one of these methods:
Use a KVM cable (Cisco PID N20-BKVM) to connect a keyboard and monitor to the KVM connector on the front panel of the server.
If you want to use vKVM, see Installing an OS Using the KVM Console in Cisco UCS C-Series Integrated Management Controller GUI Configuration Guide, Release 4.3.
Connect a USB keyboard and VGA monitor to the corresponding connectors on the rear panel of the server.
![]() Note |
You cannot use the front panel VGA and the rear panel VGA at the same time. |
You can make a serial connection using one of the following methods. Two of these methods require a configuration change in the CIMC:
![]() Note |
You cannot use more than one of these methods simultaneously. |
Use the DB9 connector of the KVM cable
Use the rear panel RJ-45 console port (after enabling in the CIMC)
Connect by Serial-over-LAN (SoL) (after enabling in the CIMC)
The default connection settings from the factory are:
The serial port baud rate is 115200
The RJ-45 console port located on the rear panel is disabled in the CIMC
SoL is disabled in the CIMC
The following are additional notes about serial access:
If you are using a Cisco Integrated Management Controller (CIMC) for your setup, setup the CIMC first, and then access the Cisco APIC through the CIMC KVM or continue to access the Cisco APIC locally through the rear panel USB/VGA port. If you choose the CIMC KVM access, you will have remote access available later which is required during operations.
If you are using the RJ-45 console port, connect to CIMC using SSH and enable the SoL port using the following commands:
scope sol
set enabled yes
set baud-rate 115200
commit
exit
After enabling SoL, enter the command connect host to access the APIC console.
![]() Note |
When using SoL, physically disconnect the rear panel RJ-45 console port. |
When the Cisco APIC is launched for the first time, the APIC console presents a series of initial setup options. For many options, you can press Enter to choose the default setting that is displayed in brackets. At any point in the setup dialog, you can restart the dialog from the beginning by pressing Ctrl-C.
If the UNIX user ID is not explicitly specified in the response from the remote authentication server, then some Cisco APIC software releases assign a default ID of 23999 to all users. If the response from the remote authentication server fails to specify a UNIX ID, all users will share the same ID of 23999 and this can result in the users being granted higher or lower privileges than the configured privileges through the RBAC policies on the Cisco APIC.
Cisco recommends that you assign unique UNIX user IDs in the range of 16000 to 23999 for the AV Pairs that are assigned to the users when in Bash shell (using SSH, Telnet, or Serial/KVM consoles). If a situation arises where the Cisco AV Pair does not provide a UNIX user ID, the user is assigned a user ID of 23999 or similar number from the range that also enables the user's home directories, files, and processes accessible to the remote users with a UNIX ID of 23999.
To ensure that your remote authentication server does not explicitly assign a UNIX ID in its cisco-av-pair response, open an SSH session to the Cisco APIC and log in as an administrator (using a remote user account). Once logged in, run the following commands (replace userid with the username that you logged in with):
admin@apic1: remoteuser-userid> cd /mit/uni/userext/remoteuser-userid
admin@apic1: remoteuser-userid> cat summary
Cisco recommends against modifying any parameters using CIMC. If there are any issues, ensure that the default setting for CIMC management node is Dedicated mode and not Shared. If Dedicated mode is not used, it can prevent the discovery of fabric nodes.
Do not upgrade software or firmware using the CIMC user interface, XML, or SSH interfaces unless the modified property and software or firmware version are supported with your specific Cisco APIC version.
Set the NIC mode to Dedicated, when setting up the CIMC, in the CIMC Configuration Utility. After the CIMC is configured, in the CIMC GUI, verify that you have the following parameters set.
|
Parameters |
Settings |
|
LLDP |
Disabled on the VIC |
|
TPM Support |
Enabled on the BIOS |
|
TPM Enabled Status |
Enabled |
|
TPM Ownership |
Owned |
If you log in to your Cisco APIC using https, and then attempt to log in to the same Cisco APIC using http in the same browser window without first logging out of the Cisco APIC in the https window, you might see the following error message:
Need a valid webtoken cookie (named APIC-Cookie) or a signed request with signature in the cookie.If this occurs, resolve the issue using either of the following methods:
Log out of the Cisco APIC in the https window, or
Delete the cookies in the browser window
You should be able to successfully log into the Cisco APIC using http after resolving the issue with either of the methods above.
During the initial setup, the system will prompt you to select IPv4, or IPv6, or dual stack configuration. Choosing dual stack will enable accessing the Cisco APIC and Cisco ACI fabric out-of-band management interfaces with either IPv4 or IPv6 addresses. While the examples in the table below use IPv4 addresses, you can use whatever IP address configuration options you chose to enable during the initial setup.
A minimum subnet mask of /19 is recommended.
Connecting the Cisco APIC to the Cisco ACI fabric requires a 10G interface on the ACI-mode leaf switch. You cannot connect the Cisco APIC directly to the Cisco Nexus 9332PQ, Cisco Nexus 93180LC, or Cisco Nexus 9336C-FX2 ACI-mode leaf switches unless you use a 40G to 10G converter (part number CVR-QSFP-SFP10G), in which case the port on the leaf switches will auto-negotiate to 10G without requiring any manual configuration.
The fabric ID is set during the Cisco APIC setup and it cannot be changed unless you perform a clean reload of the fabric. To change the fabric ID, export the Cisco APIC configuration, change the sam.config file, and perform a clean reload of the Cisco APIC and leaf switches. Remove the "fvFabricExtConnP" setting from the exported configuration before importing the configuration into the Cisco APIC after the Cisco APIC comes up. All Cisco APICs in a cluster must have the same fabric ID.
All logging is enabled by default.
For login and cluster operations, non-default HTTPS port (default is 443) is not supported for layer 3 physical and layer 3 virtual APICs (on ESXi and AWS). Virtual APICs on ESXi/ AWS are supported from release 6.0(2).
|
Name |
Description |
Default value |
||
|---|---|---|---|---|
|
Fabric name |
Fabric domain name |
ACI Fabric1 |
||
|
Fabric ID |
Fabric ID |
1 |
||
|
Number of active controllers |
Cluster size |
3
|
||
|
POD ID |
POD ID |
1 |
||
|
Standby controller |
Setup standby controller |
no |
|
Name |
Description |
Default value |
||
|---|---|---|---|---|
|
Fabric name |
Fabric domain name |
ACI Fabric1 |
||
|
Fabric ID |
Fabric ID |
1 |
||
|
Number of active controllers |
Cluster size |
3
|
||
|
POD ID |
POD ID |
1 |
||
|
Standby controller |
Setup standby controller |
yes |
This procedure provides details of the initial cluster set up and bootstrapping process. Enter the relevant details for each of the screens
The APIC Cluster Bringup GUI supports virtual and physical APIC platforms. The virtual APICs (deployed using ESXi or AWS), and physical APICs can be connected to the ACI fabric directly to the leaf switches or remotely attached through a layer 3 network. The GUI supports both the scenarios. A major advantage of using the APIC Cluster Bringup GUI is that, you do not need to enter the parameters for every APIC in a cluster. One APIC can relay the information to the other APICs of the cluster.
Alternatively, you can perform the initial setup and cluster bringup using the REST APIs. See the Getting Started section of the APIC REST API Configuration Procedures guide.
For virtual APIC on ESXi, ensure to complete the deployment of the APIC VM using the OVF template on the VMware vCenter GUI. For a three-node cluster, configure three VMs with the management IP address, gateway, and admin passwords. The number of VMs is dependent on the size of the APIC cluster.
For virtual APIC on AWS, ensure to complete the deployment of the APIC VM using the cloud formation template (CFT) on the AWS GUI. AWS allocates IP addresses dynamically from the out-of-band (OOB)/infra/inband subnets accordingly, to correspond with the network adapters of the virtual APIC's EC2 instance.
For virtual APICs (deployed using AWS/ ESXi), ensure that the admin password(s) are the same for all the APICs in a cluster.
For the physical APIC cluster, configure the OOB address for APIC 1. Ensure that the CIMC addresses of APICs 2 to N (where N is the cluster size) are reachable via the OOB address of APIC 1.
Connectivity between out-of-band and the CIMC is mandatory.
Limitations:
No support for IPv6 addresses on virtual APICs deployed using AWS.
For login and cluster operations, non-default HTTPS port (default is 443) is not supported for remotely-attached APICs (physical and virtual).
|
Step 1 |
Log in to the APIC 1 using https://APIC1-IP. |
||
|
Step 2 |
Using the OOB address, log in to the APIC Cluster Bringup GUI. |
||
|
Step 3 |
In the Select Workflow screen, choose New cluster and click Next.
The GUI screen has four parts. Enter the details in the following screens:
Each of the above screens are discussed in detail in the subsequent steps. The screens are marked as steps with sequential numbers: 1, 2, 3, and 4; after you have entered and saved the required details in each of these screens, the number is replaced with a tick-mark. |
||
|
Step 4 |
The first step is entering the Connection Type information. In the Connection Type screen, choose the type of connection between the APIC and the fabric. The options are:
If it is virtual APIC using AWS, the system detects that the APIC is remotely-attached through a Layer 3 network and proceeds directly to the Cluster Details screen. |
||
|
Step 5 |
Click Next. |
||
|
Step 6 |
The second step is entering the Cluster Details. Enter the fabric-level details in the Cluster Details screen.
|
||
|
Step 7 |
Click Next. |
||
|
Step 8 |
The third step is entering the Controller Registration details. Click Add Controller to add the first APIC (of the cluster). Enter the following details:
|
||
|
Step 9 |
Click Next. The Next button is disabled until all the controllers for a cluster are added. This is defined by the value you have entered for Cluster Size in the Cluster Details screen. You can use the Back button to navigate to an earlier screen. After adding an APIC, click Edit Details to edit the information for an APIC. Except the first APIC, you can delete the other controllers, if required, by clicking the delete icon. |
IPv6 management addresses can be provisioned on the Cisco Application Policy Infrastructure Controller (APIC) at setup time or through a policy once the Cisco APIC is operational. Pure IPv4, pure IPv6, or dual stack (that is, both IPv6 and IPv4 addresses) are supported.
For the detailed cluster bring up procedure, see Bring up the APIC cluster using the GUI.
Use this procedure to access the APIC GUI.
APIC GUI is the interface which enables you to configure the APIC. The Cisco APIC can be configured using the GUI or using REST API or CLI.
|
Step 1 |
Open one of the supported browsers:
|
||||
|
Step 2 |
Enter the URL: https://mgmt_ip-address Use the out-of-band management IP address that you configured during the initial setup. For example, https://192.168.10.1.
|
||||
|
Step 3 |
When the login screen appears, enter the administrator name and password that you configured during the initial setup. |
||||
|
Step 4 |
In the Domain field, from the drop-down list, choose the appropriate domain that is defined. If multiple login domains are defined, the Domain field is displayed. If the user does not choose a domain, the DefaultAuth login domain is used for authentication by default. This may result in login failure if the username is not in the DefaultAuth login domain. |
https://apic-ip-address/api/api-message-urlUse the out-of-band management IP address that you configured during the initial setup. You must send an authentication message to initiate an API session. Use the administrator login name and password that you configured during the initial setup.
![]() Note |
Only https is enabled by default. By default, http and http-to-https redirection are disabled. |
You can access the APIC NX-OS style CLI either directly from a terminal or through the APIC GUI.
The CLI is supported only for users with administrative login privileges.
The APIC NX-OS style CLI uses similar syntax and other conventions to the Cisco NX-OS CLI, but the APIC operating system is not a version of Cisco NX-OS software. Do not assume that a Cisco NX-OS CLI command works with or has the same function on the APIC CLI.
If FIPS is enabled in the Cisco ACI setups, then SHA256 support is mandatory on the SSH Client. Additionally, to have the SHA256 support, the openssh-client must be running version 6.6.1 or higher.
The object model CLI is available by typing the bash command at the initial CLI prompt.
Use this procedure to access the NX-OS style CLI from a terminal.
|
Step 1 |
From a secure shell (SSH) client, open an SSH connection to APIC at username@ip-address . Use the administrator login name and the out-of-band management IP address that you configured during the initial setup. For example, admin@192.168.10.1. |
|
Step 2 |
When prompted, enter the administrator password. |
When you enter the NX-OS style CLI, the initial command level is the EXEC level. You can stay in EXEC mode or you can type configure to enter global configuration mode. In any mode, type ? to see the available commands.
For information about using the NX-OS style CLI commands, see the Cisco APIC NX-OS Style Command-Line Interface Configuration Guide and the Cisco APIC NX-OS Style CLI Command Reference.
Use this procedure to access the NX-OS style CLI from the APIC GUI.
|
Step 1 |
From the menu bar, choose System > Controllers. |
|
Step 2 |
In the navigation pane, click Controllers. |
|
Step 3 |
Right-click the desired APIC and choose Launch SSH. |
|
Step 4 |
Follow the displayed instructions to open an SSH session to the selected controller. |
When you enter the NX-OS style CLI, the initial command level is the EXEC level. You can stay in EXEC mode or you can type configure to enter global configuration mode. In any mode, type ? to see the available commands.
For information about using the NX-OS style CLI commands, see the Cisco APIC NX-OS Style Command-Line Interface Configuration Guide and the Cisco APIC NX-OS Style CLI Command Reference.
Use this procedure to access the object model CLI. The object model CLI is available by typing the bash command at the initial CLI prompt.
|
Step 1 |
From a secure shell (SSH) client, open an SSH connection to username@ip-address . Use the administrator login name and the out-of-band management IP address that you configured during the initial setup. For
example, |
|
Step 2 |
When prompted, enter the administrator password that you configured during the initial setup. You are now in the NX-OS style CLI for APIC. |
|
Step 3 |
Type bash to enter the object model CLI. |
|
Step 4 |
To return to the NX-OS style CLI, type exit . This example shows how to enter the object model CLI and how to return to the NX-OS style CLI:
|
Every user must use the shared directory called /home. This directory gives permissions for a user to create directories and files; files created within /home inherit the default umask permissions and are accessible by the user and by root. We recommend that users create a /home/userid directory to store files, such as /home/jsmith, when logging in for the first time.
For detailed information about configuring the APIC CLI, see the Cisco APIC Object Model Command Line Interface User Guide.