Cisco UCS Director Shell Guide, Release 5.3
First Published: July 16, 2015
Last Modified: September 11, 2015
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
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.
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)
© 2015
Cisco Systems, Inc. All rights reserved.
CONTENTS
Preface
Preface vii
Audience vii
Conventions vii
Related Documentation ix
Documentation Feedback ix
Obtaining Documentation and Submitting a Service Request ix
CHAPTER 1
New and Changed Information for this Release 1
New and Changed Information 1
CHAPTER 2
Overview 3
About Cisco UCS Director 3
About Cisco UCS Director Shell Commands 4
Prerequisites 5
Logging into the Shell 5
CHAPTER 3
Using Shell Commands 7
General Administration 7
Examining the Version Information 7
Stopping Cisco Services 8
Starting Cisco Services 8
Displaying the Status of Your Services 9
Changing Your Password 10
Synchronizing the System Time 11
Pinging the Hostname and IP Address 11
Configuring a Network Interface 12
Displaying Appliance Network Details 13
Cisco UCS Director Shell Guide, Release 5.3
iii
Contents
Adding the Cisco UCS Director Baremetal Agent Hostname and IP Address 13
Viewing Tail Inframgr Logs 14
Applying a Patch to Cisco UCS Director 14
Collecting Logs from a Node 16
Collecting Diagnostics 17
Working with Databases 18
Stopping the Database 18
Starting the Database 19
Backing Up the Database 19
Restoring the Database 20
Enabling the Database for Cisco UCS Director Baremetal Agent 21
Managing SSL Certificates 22
Generating Self-Signed Certificates and Certificate Signing Requests 22
Importing Certification Authority or Self-Signed Certificates 24
Accessing Root Privileges 25
Configuring Root Access 25
Enabling Root Access 25
Disabling Root Access 26
Logging in as Root 26
CHAPTER 4
Configuring a Multi-Node Setup 29
About the Multi-Node Setup 29
Primary Node 31
Service Nodes 31
Database Nodes 31
Minimum System Requirements for a Multi-Node Setup 31
Minimum System Requirements for a Small Multi-Node Setup 32
Minimum System Requirements for a Medium Multi-Node Setup 33
Minimum System Requirements for a Large Multi-Node Setup 36
Guidelines and Limitations for a Multi-Node Setup 38
Best Practices for a Multi-Node Setup 39
Summary of Steps for Configuring a Multi-Node Setup 39
Creating the Inventory Database 40
Creating the Monitoring Database 41
Creating the Primary Node 41
Cisco UCS Director Shell Guide, Release 5.3
iv
Contents
Creating a Service Node 42
System Tasks 43
Creating a Node Pool 44
Creating System Task Policy 44
Assigning a Node Pool to System Task Policy 45
Creating a Service Node 45
Assigning a System Policy to a System Task 46
Executing System Tasks 47
Disabling or Enabling a System Task 47
Backing Up with a Multi-Node Setup 47
Restoring with a Multi-Node Setup 48
Removing a Service Node 49
Options for Migrating from a Standalone Appliance to a Multi-Node Setup 49
Migrating a Release 4.0 Standalone Appliance to a Multi-Node Setup with a Full Database
Backup 50
Migrating a Release 4.0 Standalone Appliance to a Multi-Node Setup with a Selected Database
Backup 51
Migrating a Release 4.1 Standalone Appliance to a Multi-Node Setup with Selective Database
Table Backup 53
Cisco UCS Director Shell Guide, Release 5.3
v
Contents
Cisco UCS Director Shell Guide, Release 5.3
vi
Preface
• Audience, page vii
• Conventions, page vii
• Related Documentation, page ix
• Documentation Feedback, page ix
• Obtaining Documentation and Submitting a Service Request, page ix
Audience
This guide is intended primarily for data center administrators who use Cisco UCS Director and who have
responsibilities and expertise in one or more of the following:
• Server administration
• Storage administration
• Network administration
• Network security
• Virtualization and virtual machines
Conventions
Text Type
Indication
GUI elements
GUI elements such as tab titles, area names, and field labels appear in this font.
Main titles such as window, dialog box, and wizard titles appear in this font.
Document titles
Document titles appear in this font.
TUI elements
In a Text-based User Interface, text the system displays appears in this font.
Cisco UCS Director Shell Guide, Release 5.3
vii
Preface
Conventions
Text Type
Indication
System output
Terminal sessions and information that the system displays appear in this
font.
CLI commands
CLI command keywords appear in this font.
Variables in a CLI command appear in this font.
Note
Tip
[]
Elements in square brackets are optional.
{x | y | z}
Required alternative keywords are grouped in braces and separated by vertical
bars.
[x | y | z]
Optional alternative keywords are grouped in brackets and separated by vertical
bars.
string
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
<>
Nonprinting characters such as passwords are in angle brackets.
[]
Default responses to system prompts are in square brackets.
!, #
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
document.
Means the following information will help you solve a problem. The tips information might not be
troubleshooting or even an action, but could be useful information, similar to a Timesaver.
Caution
Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Timesaver
Means the described action saves time. You can save time by performing the action described in the
paragraph.
Cisco UCS Director Shell Guide, Release 5.3
viii
Preface
Related Documentation
Warning
IMPORTANT SAFETY INSTRUCTIONS
This warning symbol means danger. You are in a situation that could cause bodily injury. Before you
work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with
standard practices for preventing accidents. Use the statement number provided at the end of each warning
to locate its translation in the translated safety warnings that accompanied this device.
SAVE THESE INSTRUCTIONS
Related Documentation
Cisco UCS Director Documentation Roadmap
For a complete list of Cisco UCS Director documentation, see the Cisco UCS Director Documentation
Roadmap available at the following URL: http://www.cisco.com/en/US/docs/unified_computing/ucs/
ucs-director/doc-roadmap/b_UCSDirectorDocRoadmap.html.
Cisco UCS Documentation Roadmaps
For a complete list of all B-Series documentation, see the Cisco UCS B-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/b-series-doc.
For a complete list of all C-Series documentation, see the Cisco UCS C-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/c-series-doc.
Note
The Cisco UCS B-Series Servers Documentation Roadmap includes links to documentation for Cisco
UCS Manager and Cisco UCS Central. The Cisco UCS C-Series Servers Documentation Roadmap includes
links to documentation for Cisco Integrated Management Controller.
Documentation Feedback
To provide technical feedback on this document, or to report an error or omission, please send your comments
to [email protected]. We appreciate your feedback.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service
request, and gathering additional information, see What's New in Cisco Product Documentation, at: http://
www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.
Subscribe to What's New in Cisco Product Documentation, which lists all new and revised Cisco technical
documentation as an RSS feed and delivers content directly to your desktop using a reader application. The
RSS feeds are a free service.
Cisco UCS Director Shell Guide, Release 5.3
ix
Preface
Obtaining Documentation and Submitting a Service Request
Cisco UCS Director Shell Guide, Release 5.3
x
CHAPTER
1
New and Changed Information for this Release
• New and Changed Information, page 1
New and Changed Information
The following table provides an overview of the significant changes to this guide for this current release. The
table does not provide an exhaustive list of all changes made to this guide or of all new features in this release.
Table 1: New Features and Changed Behavior in Cisco UCS Director Shell, Release 5.3
Feature
Description
Where Documented
Managing SSL Certificates topics Provides ability to generate and import Generating Self-Signed
certificates using updated shell menu Certificates and Certificate
options.
Signing Requests, on page 22
Importing Certification
Authority or Self-Signed
Certificates, on page 24
Cisco UCS Director Shell Guide, Release 5.3
1
New and Changed Information for this Release
New and Changed Information
Cisco UCS Director Shell Guide, Release 5.3
2
CHAPTER
2
Overview
This chapter contains the following sections:
• About Cisco UCS Director, page 3
• About Cisco UCS Director Shell Commands, page 4
• Prerequisites, page 5
• Logging into the Shell, page 5
About Cisco UCS Director
Cisco UCS Director is a complete highly secure, end-to-end management, orchestration, and automation
solution for a wide array of Cisco and non-Cisco data infrastructure components, and for the industry's leading
converged infrastructure solutions based on the Cisco UCS and Cisco Nexus platforms. For a complete list
of supported infrastructure components and solutions, see the Cisco UCS Director Compatibility Matrix..
Cisco UCS Director is a 64-bit appliance that uses the following standard templates:
• Open Virtualization Format (OVF) for VMware vSphere
• Virtual Hard Disk (VHD) for Microsoft Hyper-V
Management through Cisco UCS Director
Cisco UCS Director extends the unification of computing and network layers through Cisco UCS to provide
you with comprehensive visibility and management of your data center infrastructure components. You can
use Cisco UCS Director to configure, administer, and monitor supported Cisco and non-Cisco components.
The tasks you can perform include the following:
• Create, clone, and deploy service profiles and templates for all Cisco UCS servers and compute
applications.
• Monitor organizational usage, trends, and capacity across a converged infrastructure on a continuous
basis. For example, you can view heat maps that show virtual machine (VM) utilization across all your
data centers.
• Deploy and add capacity to converged infrastructures in a consistent, repeatable manner.
Cisco UCS Director Shell Guide, Release 5.3
3
Overview
About Cisco UCS Director Shell Commands
• Manage, monitor, and report on data center components, such as Cisco UCS domains or Cisco Nexus
network devices.
• Extend virtual service catalogs to include services for your physical infrastructure.
• Manage secure multi-tenant environments to accommodate virtualized workloads that run with
non-virtualized workloads.
Automation and Orchestration with Cisco UCS Director
Cisco UCS Director enables you to build workflows that provide automation services, and to publish the
workflows and extend their services in an on-demand manner to your users. You can collaborate with other
experts in your company to quickly and easily create policies and build Cisco UCS Director workflows to
automate simple or complex provisioning and configuration processes.
Once built and validated, these workflows perform the same way every time, no matter who runs the workflows.
An experienced data center administrator can run them, or you can implement role-based access control to
enable your users and customers to run the workflows on a self-service, as needed, basis.
With Cisco UCS Director, you can automate a wide array of tasks and use cases across a wide variety of
supported Cisco and non-Cisco hardware and software data center components. A few examples of the use
cases that you can automate include, but are not limited to:
• VM provisioning and lifecycle management
• Network resource configuration and lifecycle management
• Storage resource configuration and lifecycle management
• Tenant onboarding and infrastructure configuration
• Application infrastructure provisioning
• Self-service catalogs and VM provisioning
• Baremetal server provisioning, including installation of an operating system
About Cisco UCS Director Shell Commands
This guide describes all of the commands available to you when logging into the Cisco UCS Director shell.
You can use these commands to perform the following administrative tasks:
• Stopping/starting all Cisco services
• Display Service Status
• Stopping/starting the MySQL database
• Backing up/restoring the appliance database
• Changing ShellAdmin password
• Synching up time
• Configuring network interface
• Enabling the database for a BMA Appliance
• Adding a BMA hostname/IP address to the appliance
Cisco UCS Director Shell Guide, Release 5.3
4
Overview
Prerequisites
• Displaying network details
• Pinging hostname/IP address
• Version (Cisco UCS Director appliance version)
• Importing CA (JKS) file
• Importing CA Cert (PEM) file for Virtual Network Computing (VNC)
• Shutdown of the Appliance
• Rebooting the Appliance
• Manage Root Access
• Troubleshooting by using Tail Inframgr logs
• Applying a patch to the appliance
• Quitting the shell
• Login as Root
• Configuring Multi-node Setup
• Clean Up Patch Files
• Migrating from Single to Multi-Node
For additional system administration information refer to the Cisco UCS Director Administration Guide.
Prerequisites
To successfully execute the commands described in this guide, you must meet the following prerequisites:
• Cisco UCS Director should be up and running (and reachable).
Note
The information in this guide is based on Cisco UCS Director, release 4.0 and later releases.
Logging into the Shell
The login procedure requires the use of a Secure Shell (SSH) client and the proper login credentials. After
gaining access to Cisco UCS Director appliance you can perform a wide variety of system administration
tasks.
Cisco UCS Director Shell Guide, Release 5.3
5
Overview
Logging into the Shell
Before You Begin
Obtain proper access to a Cisco UCS Director appliance and a secure shell (SSH) application.
Step 1
Step 2
Step 3
Open your SSH application.
Enter the Cisco UCS Director appliance IP address.
In the Port field, enter 22.
The shell window displays the introductory Cisco UCS Director Shell Menu.
Step 4
Step 5
In the User field, enter shelladmin.
In the Password field, enter one of the two following choices:
• Enter changeme.
• From the CLI, enter SSH shelladmin@<IP Address>.
Step 6
Press the Enter key.
The following services are available for selection:
Cisco UCS Director Shell Menu
Select a number from the menu below
1)
2)
3)
4)
5)
6)
7)
8)
9)
10)
11)
12)
13)
14)
15)
16)
17)
18)
19)
20)
21)
22)
23)
24)
25)
26)
27)
28)
Change ShellAdmin password
Display Services Status
Stop Services
Start Services
Stop Database
Start Database
Backup Database
Restore Database
Time Sync
Ping Hostname/IP Address
Show version
Generate Self-Signed Certificate and Certificate Signing Request
Import CA/Self-Signed Certificate
Configure Network Interface
Display Network Details
Enable Database for Cisco UCS Director Baremetal Agent
Add Cisco UCS Director Baremetal Agent Hostname/IP
Tail Inframgr logs
Apply Patch
Shutdown Appliance
Reboot Appliance
Manage Root Access
Login as Root
Configure Multi Node Setup (Advanced Deployment)
Clean-up Patch Files
Collect logs from a Node
Collect Diagnostics
Quit
SELECT>
Note
Some minor Cisco UCS Director releases (after release 4.0) may or may not include all of the options listed
above.
Cisco UCS Director Shell Guide, Release 5.3
6
CHAPTER
3
Using Shell Commands
This chapter contains the following sections:
• General Administration, page 7
• Working with Databases, page 18
• Managing SSL Certificates, page 22
• Accessing Root Privileges, page 25
General Administration
This section describes how to execute common administration tasks such as changing your password, stopping
and starting services, generating log and report data, as well as other common system administration tasks.
Examining the Version Information
You can verify the Cisco UCS Director version and build number by choosing Show Version. This information
is required for debugging purposes.
Step 1
From the Cisco UCS Director Shell menu choose Show Version and press Enter.
Information similar to the following is displayed:
Cisco UCS-D
----------Version
: 5.0.0.0
Build Number : 22
Press return to continue ...
Step 2
Press Enter to complete the process.
Cisco UCS Director Shell Guide, Release 5.3
7
Using Shell Commands
Stopping Cisco Services
Stopping Cisco Services
You can stop all Cisco services that are part of the Cisco UCS Director appliance by choosing Stop Services.
You can verify that all services are stopped by choosing Display Service Status.
SUMMARY STEPS
1. From the Cisco UCS Director Shell menu choose Stop Services.
2. Press Enter.
3. Press Enter to complete the procedure.
DETAILED STEPS
Step 1
Step 2
From the Cisco UCS Director Shell menu choose Stop Services.
Press Enter.
The following information displays:
Stopping broker [PID=17364]/[Child=17365]
Stopping controller [PID=17402]/[Child=17404]
Stopping eventmgr [PID=17471]/[Child=17473]
Stopping client [PID=17535]/[Child=17537
17615
17678]
Stopping idaccessmgr [PID=17613]/[Child=]
/opt/infra/stopInfraAll.sh: line 35: kill: (17613) - No such process
Stopping inframgr [PID=17676]/[Child=]
Tomcat is running with [PID=17779]. Stoping it and its child process
Flashpolicyd is running with [PID=17807]. Stopping it
Stopping websock[PID=17812]
Press return to continue ...
Step 3
Press Enter to complete the procedure.
Starting Cisco Services
You can execute all services that are part of Cisco UCS Director by choosing Start Services.
After using this option, you can choose Display Service Status to verify that all services are executed.
Note
Step 1
Services started in the background are not displayed.
From the Cisco UCS Director Shell menu choose Start Services.
Cisco UCS Director Shell Guide, Release 5.3
8
Using Shell Commands
Displaying the Status of Your Services
The following information is displayed:
Press return to continue ...nohup: appending output to `nohup.out'
Step 2
Step 3
Press Enter to complete the process.
Choose Display Service Status to verify that the services are executed.
Displaying the Status of Your Services
The Display Services option displays all executed services. You can execute seven services at any one time.
• Broker
• Controller
• Eventmgr
• Client
• Idaccessmgr
• Inframgr
• Tomcat
• Websock (VNC interface)
• Database (mysqld)
Note
Ensure that all of the above services are up and operating. If a service is not executed on Cisco UCS
Director, restart the service through the shell client.
From the Cisco UCS Director Shell menu choose the Display Service Status option.
The following list of services appears:
Cisco UCS Director Shell Menu
Select a number from the menu below
1)
2)
3)
4)
5)
6)
7)
8)
9)
10)
11)
Change ShellAdmin password
Display Services Status
Stop Services
Start Services
Stop Database
Start Database
Backup Database
Restore Database
Time Sync
Ping Hostname/IP Address
Show version
Cisco UCS Director Shell Guide, Release 5.3
9
Using Shell Commands
Changing Your Password
12)
13)
14)
15)
16)
17)
18)
19)
20)
21)
22)
23)
24)
25)
26)
27)
28)
Generate Self-Signed Certificate and Certificate Signing Request
Import CA/Self-Signed Certificate
Configure Network Interface
Display Network Details
Enable Database for Cisco UCS Director Baremetal Agent
Add Cisco UCS Director Baremetal Agent Hostname/IP
Tail Inframgr logs
Apply Patch
Shutdown Appliance
Reboot Appliance
Manage Root Access
Login As Root
Configure Multi Node Setup (Advanced Deployment)
Clean-up Patch Files
Collect logs from a Node
Collect Diagnostics
Quit
SELECT> 2
Service
---------broker
controller
eventmgr
client
idaccessmgr
inframgr
TOMCAT
websock
Status
---------RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
PID
----18718
18758
18792
18891
18938
18997
19054
19083
2903 ?
00:00:00 mysqld_safe
3192 ?
7-10:59:53 mysqld
Press return to continue ...
Note
The corresponding status and process ID (PID) of each service is also displayed in the
menu.
Changing Your Password
You can change your Cisco UCS Director shell password by choosing Change ShellAdmin password.
Step 1
From the Cisco UCS Director Shell menu choose Change ShellAdmin passwordand press Enter. The following
information is displayed:
Changing password for user shelladmin.
New UNIX password:
Cisco UCS Director Shell Guide, Release 5.3
10
Using Shell Commands
Synchronizing the System Time
Step 2
Step 3
Enter your new UNIX password and press the Enter key.
Enter your new UNIX password once again and press the Enter key. The following information is displayed:
passwd: all authentication tokens updated successfully. Press return to continue...
Synchronizing the System Time
You can synchronize the system time to the hardware time as well as the NTP server by choosingTime Sync.
Step 1
Step 2
From the Cisco UCS Director Shell menu choose Time Sync.
Press Enter.
The following information is displayed:
Time Sync......
System time is Tue Sep 17 15:57:34 UTC 2013
Hardware time is Tue Sep 17 15:57:35 2013 -0.849104 seconds
Do you want to sync systemtime [y/n]? y
NTP Server IP Address: 172.25.168.203
5 Dec 03:24:02 ntpdate[5017]: step time server 172.25.168.203 offset 25510.954857 sec
Sync'ed with NTP SERVER 172.25.168.203
Press return to continue ...
Step 3
Step 4
Step 5
Press Y and press Enter to synchronize to system time.
Press Y and press the Enter to synchronize to the NTP server.
Press Enter key to complete the process.
Pinging the Hostname and IP Address
You can ping a hostname or IP address to test your connectivity by choosing the Ping Hostname/IP address
option.
Step 1
Step 2
From the Cisco UCS Director Shell menu choose the Ping Hostname/IP addres option and press Enter.
Enter your IP address and press Enter.
The following information is displayed:
Enter IP Address : 209.165.200.224
PING 209.165.200.224 (209.165.200.224) 56(84) bytes of data.
64 bytes from 209.165.200.224: icmp_seq=1 ttl=64 time=9.90 ms
64 bytes from 209.165.200.224: icmp_seq=2 ttl=64 time=0.316 ms
Cisco UCS Director Shell Guide, Release 5.3
11
Using Shell Commands
Configuring a Network Interface
64 bytes from 209.165.200.224: icmp_seq=3 ttl=64 time=0.254 ms
64 bytes from 209.165.200.224: icmp_seq=4 ttl=64 time=0.198 ms
64 bytes from 209.165.200.224: icmp_seq=5 ttl=64 time=0.267 ms
--- 209.165.200.224 ping statistics --5 packets transmitted, 5 received, 0% packet loss, time 3999ms
rtt min/avg/max/mdev = 0.198/2.187/9.901/3.857 ms
Press return to continue ...
Step 3
Press Enter to exit out of the operation.
Configuring a Network Interface
You can configure a network interface for the Cisco UCS Director appliance by choosing Configure a Network
Interface.
Step 1
From the Cisco UCS Director Shell menu choose Configure a Network Interface and press Enter.
The following information displays:
Do you want to Configure DHCP/STATIC IP
Step 2
[D/S] ? : S
Choose one of the following configuration selections:
• Choose D to configure a DHCP IP address.
• Choose S to configure a static IP address.
Step 3
Enter s to configure a static IP address and press Enter. The following information is displayed.
Configuring STATIC configuration..
Enter the ethernet interface that you want configure E.g. eth0 or eth1:
Step 4
Enter the Ethernet interface to configure (for example, eth1) and press Enter. The following information displays:
Configuring STATIC IP for eth1...
IP Address: 209.165.200.224
Netmask: 255.255.255.0
Gateway: 209.187.108.1
DNS Server1: 198.51.100.1
DNS Server2: 203.0.113.1
Configuring Network with : INTERACE(eth1), IP(209.165.200.224), Netmask(255.255.255.0),
Gateway(209.187.108.1),
DNS Server1(198.51.100.1), DNS Serverx 2(203.0.113.1)
Do you want to continue
Step 5
[y/n]? :
Enter n to discontinue the configuration process. Press Enter to return to complete the process.
Cisco UCS Director Shell Guide, Release 5.3
12
Using Shell Commands
Displaying Appliance Network Details
Displaying Appliance Network Details
You can display the Cisco UCS Director appliance network details by choosing the Display Network Details
option.
Step 1
From the Cisco UCS Director Shell menu choose the Display Network Details option and press Enter.
The following information is displayed:
Network details....
eth0
Link encap:Ethernet HWaddr 00:50:56:97:1E:2D
inet addr:192.0.2.23 Bcast:192.0.2.255 Mask:255.255.255.0
inet6 addr: fe80::230:56gg:fe97:1e2d/64 Scope:Link
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
RX packets:189818223 errors:14832 dropped:17343 overruns:0 frame:0
TX packets:71520969 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:1000
RX bytes:105749301003 (98.4 GiB) TX bytes:27590555706 (25.6 GiB)
Interrupt:59 Base address:0x2000
lo
Link encap:Local Loopback
inet addr:127.0.0.1 Mask:255.0.0.0
inet6 addr: ::1/128 Scope:Host
UP LOOPBACK RUNNING MTU:16436 Metric:1
RX packets:1821636581 errors:0 dropped:0 overruns:0 frame:0
TX packets:1821636581 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:0
RX bytes:327846827946 (305.3 GiB) TX bytes:327846827946 (305.3 GiB)
Press return to continue ...
Step 2
Press Enter to complete the process.
Adding the Cisco UCS Director Baremetal Agent Hostname and IP Address
Choose this option to add the Cisco UCS Director Baremetal Agent appliance hostname and IP address entries
into the Cisco UCS Director appliance's /etc/hosts file.
Step 1
From the Cisco UCS Director Shell menu choose the Add Cisco VCS Director Baremetal Agent option and press Enter.
The following information displays:
Adding Cisco UCS Direcor Baremetal Agent Hostname and IP Address entry to /etc/hosts
Enter Cisco UCS Director Baremetal Agent IP Address:192.0.2.1
Enter Cisco UCS Director Baremetal Agent Hostname:192.44.2.1
Adding host entry 192.3.55.1 to /etc/hosts
Entry 192.3.55.1 does not exists
Backed up old file...
Added new entry 192.3.55.1
Cisco UCS Director Shell Guide, Release 5.3
13
Using Shell Commands
Viewing Tail Inframgr Logs
Added 192.44.2.1 To /etc/hosts
Press return to continue ...
Step 2
Press Enter to return to complete the process.
Viewing Tail Inframgr Logs
This Shell option enables you to see inframgr (Infrastructure Manager) log data, which are generated behind
the scenes by use of the Unix tail command. When you are debugging, you can trace problems by using this
log data. You use the Tail Inframgr Logs option to immediately tail the most recent inframgr logs. The results
are displayed on your screen directly after you select this option.
Step 1
From the Cisco UCS Director Shell menu choose the Tail Inframgr Logs option and press Enter.
Following are a few sample lines, typical of the results displayed immediately after use of the Tail Inframgr Logs option:
2014-07-20 23:17:43,500 [pool-23-thread-17]
INFO getBestAgent(SystemTaskExecutor.java:308)
- No Agent available for remoting SnapMirrorHistoryStatusSchedulerTask
2014-07-20 23:17:43,502 [pool-23-thread-17]
INFO updateStatus(SystemTaskStatusProvider.java:181)
- Task: task.SnapMirrorHistoryStatusSchedulerTask changed state to OK
2014-07-20 23:17:43,562 [pool-23-thread-17]
INFO executeLocally(SystemTaskExecutor.java:133)
- Executing task locally: SnapMirrorHistoryStatusSchedulerTask
2014-07-20 23:17:43,562 [pool-23-thread-17]
INFO getClusterLeaf(ClusterPersistenceUtil.java:81)
- Leaf name LocalHost
2014-07-20 23:17:43,571 [pool-23-thread-17]
Step 2
To exit from the log file display, type Ctrl + C, then press Enter.
Applying a Patch to Cisco UCS Director
Choose this option to apply a patch to the appliance.
Cisco UCS Director Shell Guide, Release 5.3
14
Using Shell Commands
Applying a Patch to Cisco UCS Director
Note
The patch file (zip file) is provided by Cisco UCS Director. Before applying a patch:
• Review the patch release notes and the Readme file.
• Take a snapshot of your VM.
• Make a backup of your database prior to taking the patch. The Apply Patch option enables you to
make a backup as part of the Apply Patch procedure; but the best practice is to create a backup
immediately before using the Apply Patch option.
• Stop the appliance services.
Before You Begin
• Download the patch file
• Place the file in a web server or FTP server
• Choose Apply Patch from the Cisco UCS Director Shell menu
• Provide patch URL (http://WebServer/TestPkg.zip)
Step 1
From the Cisco UCS Director Shell menu choose Apply Patch and press Enter.
The following information is displayed:
Applying Patch...
Do you want to take database backup before applying patch (y/n)?
Step 2
If you entered y, enter the requested FTP server IP address and login data, then press Enter.
y
Backup will upload file to an FTP server.
Provide the necessary access credentials.
FTP Server IP Address:
FTP Server Login:
Step 3
If you entered n, enter the patch IP address and press Enter.
n
Applying Patch:
Patch URL: http://xxx.xxx.x.xxx/TestPkg.zip
Applying the Patch http://xxx.xxx.x.xxx/TestPkg.zip [y/n]? y
Note
Step 4
Refer to the Readme file for information about the
patches.
If you are prompted to confirm that you want to apply the patch, enter y, then press Enter. Follow the onscreen prompts
to complete the process.
Cisco UCS Director Shell Guide, Release 5.3
15
Using Shell Commands
Collecting Logs from a Node
What to Do Next
After the patch is applied, choose Stop Services and Start Services.
Note
Refer to the Cisco UCS Director Baremetal Agent Installation Guide for additional information.
Collecting Logs from a Node
The Collect Logs from a Node option enables you to collect logs from the local node or from a remote node.
Step 1
From the Cisco UCS Director Shell menu choose the Collect Logs from a Node Status option.
The following list of services appears:
Cisco UCS Director Shell Menu
Select a number from the menu below
1)
2)
3)
4)
5)
6)
7)
8)
9)
10)
11)
12)
13)
14)
15)
16)
17)
18)
19)
20)
21)
22)
23)
24)
25)
26)
27)
28)
Change ShellAdmin password
Display Services Status
Stop Services
Start Services
Stop Database
Start Database
Backup Database
Restore Database
Time Sync
Ping Hostname/IP Address
Show version
Generate Self-Signed Certificate and Certificate Signing Request
Import CA/Self-Signed Certificate
Configure Network Interface
Display Network Details
Enable Database for Cisco UCS Director Baremetal Agent
Add Cisco UCS Director Baremetal Agent Hostname/IP
Tail Inframgr logs
Apply Patch
Shutdown Appliance
Reboot Appliance
Manage Root Access
Login As Root
Configure Multi Node Setup (Advanced Deployment)
Clean-up Patch Files
Collect logs from a Node
Collect Diagnostics
Quit
SELECT> 26
**********************************************************************
This wizard helps to do Logs from UCSD Appliance
**********************************************************************
Cisco UCS Director Shell Guide, Release 5.3
16
Using Shell Commands
Collecting Diagnostics
Logs Collection Option :
Current Node --> Select '1'
Remote Node --> Select '2'
Exit
--> Select '3'
Please enter an option:
Step 2
Enter the Logs Collection option.
• If you choose to collect logs from the current node, a response similar to the following appears:
Collecting all feature logs....
==========================================================
Collection of Logs
==========================================================
Moving logs from /opt/infra/broker to common/logs
Moving logs from /opt/infra/client to common/logs
Moving logs from /opt/infra/controller to common/logs
Moving logs from /opt/infra/eventmgr to common/logs
Moving logs from /opt/infra/idaccessmgr to common/logs
Moving logs from /opt/infra/inframgr to common/logs
Moving logs from /opt/infra/web_cloudmgr to common/logs
Logs archive path: /opt/infra/common/logs-07-31-2014-08-36-48.tar
You can also view individual feature logs under /opt/infra/common/logs
Logs collection done for current node
Do you want to collect logs from another node?
Note
[y/n]: Collect Logs from a Node
To collect logs from another node, the best practice is to return to the Shell menu, select the Collect Logs
from a Node option again, and choose the Remote Node option.
• If you choose to collect logs from a remote node, a response similar to the following appears:
Please enter the remote server IP/Hostname from where we collect logs:
Follow the onscreen instructions to provide the address of the remote log, establish a secure connection, and provide
the required login credentials for that remote node.
Collecting Diagnostics
The Collect Diagnostics option generates a Summary Report (SummaryReport.txt) and a detail report
(DiagOutput.txt) and stores these files under /opt/diagnostics.
From the Cisco UCS Director Shell menu, choose option Collect Diagnostics.
Information similar to the following appears, advising you that the diagnostic files have been created:
SELECT> 27
***************
Diagnostic Tool
***************
Please find the below files under /opt/diagnostics :
Cisco UCS Director Shell Guide, Release 5.3
17
Using Shell Commands
Working with Databases
Summary Report: SummaryReport.txt
Diagnostics report: DiagOutput.txt
/opt/diagnostics/rules
Press return to continue...
Working with Databases
This section describes how to enable, start and stop, as well as backup and restore a database.
Stopping the Database
You can halt the mysql daemon (mysqld) by choosing the Stop Database option. This option stops all of the
following Cisco services:
• Broker
• Controller
• Eventmgr
• Client
• Idaccessmgr
• Inframgr
• Tomcat
• Websock
Step 1
From the Cisco UCS Director Shell menu choose the Stop Database option.
The following information is displayed:
Do you want to stop the database [y/n]? y
Stopping database....
Database stopped....
Stopping broker [PID=21921]/[Child=21923]
Stopping controller [PID=21959]/[Child=21961]
Stopping eventmgr [PID=21993]/[Child=21995]
Stopping client [PID=22052]/[Child=22054
22101
22160]
Stopping idaccessmgr [PID=22099]/[Child=]
Stopping inframgr [PID=22158]/[Child=]
Tomcat is running with [PID=22213]. Stoping it and its child process
Cisco UCS Director Shell Guide, Release 5.3
18
Using Shell Commands
Starting the Database
Flashpolicyd is running with [PID=22237]. Stopping it
Stopping websock[PID=22242]
Press return to continue ...
Step 2
Follow the onscreen prompts to complete the process by choosing the Start Database option.
Starting the Database
You can start the mysql daemon (mysqld) by choosing the Start Database option.
Note
Step 1
Step 2
This option starts the appliance database only.
From the Cisco UCS Director Shell menu choose the Start Database option.
Press Enter.
The following information is displayed:
Starting database.....
directory (/var/lib/mysql/data/confmgr_production) exists
directory (/var/lib/mysql/data/db_private_admin) exists
the file (/var/lib/mysql/data/ib_logfile1) exists
the file (/var/lib/mysql/data/ib_logfile0) exists
the file (/var/lib/mysql/data/ibdata1) exists
Database started
Press return to continue ...130917 10:10:54 mysqld_safe Logging to '/var/log/mysqld.log'.
130917 10:10:54 mysqld_safe Starting mysqld daemon with databaes from /var/lib/mysql/data
Note
The Cisco services are not started automatically when you start the appliance database. Choose the Start Services
option to start the Cisco services.
Backing Up the Database
You can backup the appliance database to an FTP server. Before you begin the backup process, you must first
stop the Cisco services. To stop the services choose the Stop Services option.
You need the following information in order to execute the task:
• FTP server's IP address (where the database is to be backed up)
• FTP server's login credentials
Cisco UCS Director Shell Guide, Release 5.3
19
Using Shell Commands
Restoring the Database
Note
After the FTP credentials are provided, the entire database of the Cisco UCS Director appliance is backed
up at the specified FTP location. You then have the option to start the Cisco services by choosing the Start
Services option.
Before You Begin
Stop the Cisco services by using the Cisco UCS Director Shell Stop Services option.
Step 1
Step 2
Step 3
If you have not already done so, stop the Cisco services by using the Stop Services option. Refer to the Shell documentation
about using that option.
From the Cisco UCS Director Shell menu, choose the Backup Database option.
Press Enter.
The following information is displayed:
Backing database......
Backup will Upload file to an FTP server. Provide the necessary access credentials
FTP Server IP Address: xxxx.xxxx.xxxx.xxxx
FTP Server Login:
Step 4
Step 5
Step 6
Enter your FTP Server IP address and press Enter.
Enter your FTP Server login name and press Enter.
Enter your FTP Server password and press Enter.
Messages will appear to confirm the progress of your backup.
Restoring the Database
Before restoring the database, stop the Cisco services. To stop the services, choose the Stop Services option.
Provide the following information in order to execute the task:
• FTP server's IP address (where the database is to be restored from)
• FTP server's login credentials
• Restore filename
• Confirm to restore
Cisco UCS Director Shell Guide, Release 5.3
20
Using Shell Commands
Enabling the Database for Cisco UCS Director Baremetal Agent
Note
Step 1
Step 2
After FTP credentials are provided, the entire database of the Cisco UCS Director appliance is restored
from the specified FTP location. You can then start the Cisco services by choosing the Start Services
option.
From the Cisco UCS Director Shell Menu choose the Restore Services option.
Press Enter.
The following information displays:
Restore database......
Restore will recover file from an FTP server. Provide the necessary access credentials
FTP Server IP Address:
FTP Server Login: root
FTP Server Password:
Step 3
Step 4
Step 5
Step 6
Step 7
Enter your FTP server IP address and press Enter.
Enter your FTP server login and press Enter.
Enter your FTP server password and press the Enter.
Follow the onscreen prompts to complete the process.
Choose the Start Services option to restart the Cisco services.
Enabling the Database for Cisco UCS Director Baremetal Agent
You can enable remote database access for the Cisco UCS Director Baremetal Agent appliance by choosing
the Enabling the Database for BMA option.
Note
Step 1
This option is required for configuration of the Cisco UCS Director appliance with the BMA appliance.
From the Cisco UCS Director Shell menu choose the Enabling the Database for Cisco UCS Directory Baremetal Agent
option and press Enter.
The following information is displayed:
Do you want to enable 'remote database' access for Cisco UCS Director Baremetal Agent [y/n]? y
Cisco UCS Director Baremetal Agent Hostname/IP Address: 192.168.0.241
Step 2
Choose y and press Enter.
The following information is displayed:
Cisco UCS Director Baremetal Agent Hostname/IP Address: 192.0.2.0
Enabling 'remote database' access for 192.0.2.0
Enabling remote database access to 192.0.2.0
About to enable remote access to database - please be catious that this is only supported for Cisco
UCS Director Baremetal Agent
Cisco UCS Director Shell Guide, Release 5.3
21
Using Shell Commands
Managing SSL Certificates
About to enable remote access to database (192.0.2.0) please be catious that this is only supported
for Cisco UCS Director
Baremetal Agent
INFO (DBEnableRemoteAccess.java:195) About to enable remote access to database (192.0.2.0) please
be catious that this is
only supported for Cisco UCS Director Baremetal Agent
Remote DB access enabled
INFO (DBEnableRemoteAccess.java:213) About to enable remote access to datbase - please be catious
that this is only supported
for Cisco UCS Director Baremetal Agent
flushPrivileges - About to enable remote access to database - please be catious that this is only
supported for Cisco UCS
Director Baremetal Agent
INFO (DBEnableRemoteAccess.java:119) flushPrivileges - About to enable remote access to database please be catious that
this is only supported for Cisco UCS Director Baremetal Agent
Enabled 'Remote' database access
INFO (DBEnableRemoteAccess.java:219) Enabled 'Remote' database access
Sucessfully added credential for ipAddress 192.0.2.01
flushPrivileges - About to enable remote access to database - please be catious that this is only
supported for Cisco UCS
Director Baremetal Agent
INFO (DBEnableRemoteAccess.java:119) flushPrivileges - About to enable remote access to database please be catious that
this is only supported for Cisco UCS Director Baremetal Agent
Enabled 'Remote' database access for: 192.0.2.0
INFO (DBEnableRemoteAccess.java:679) Enabled 'Remote' database access for: 192.0.2.0
Completed remote database access...
Press return to continue ...
Step 3
Press Enter to return to the main menu.
Managing SSL Certificates
This section describes how to generate a Self-Signed certificate and Certificate Signing Request (CSR) that
can be used to obtain SSL certificates from a Certificate Authority such as Verisign, Digicert, etc. It also
provides instructions to import the generated Self-Signed certificate or CA certificate in Cisco UCS Director.
Generating Self-Signed Certificates and Certificate Signing Requests
When you generate a self-signed certificate, a new self-signed certificate in PEM format and a Certificate
Signing Request (CSR) file are created in the opt/certs/ directory. When generating a self-signed
certificate, clicking enter will select the default option. For example, if you do not specify a domain name,
the shell admin will by default pick the domain name of the appliance that is configured.
Cisco UCS Director Shell Guide, Release 5.3
22
Using Shell Commands
Generating Self-Signed Certificates and Certificate Signing Requests
You can generate a self-signed certificate and a CSR using the Generate Self-Signed Certificate and Certificate
Signing Request option.
Step 1
From the Cisco UCS Director Shell Menu choose the Generate Self-Signed Certificate and Certificate Signing Request
and press Enter.
The following information is displayed:
Domain Name [localdom]:
Step 2
Enter the domain name and press Enter.
By default the shell menu will select the domain name of the local appliance that is configured.
The following information is displayed:
How many days is self-signed certificate valid for? [365]:
Step 3
Enter the number of days that you want the self-signed certificate to be valid for and press Enter.
The following information is displayed:
Generating a 2048 bit RSA private key
writing new private key to 'opt/certs/localdom.key'
-----You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or DN.
There are quite a few fields but you can leave some blank.
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----Country Name (2 letter code) [GB]:
State or Province Name (full name) [Berkshire]:
Locality Name (eg, city) [Newbury]:
Organization Name (eg, company) [My Company Ltd]:
Organizational Unit Name (eg, section) []:
Common Name (eg, your name or your server's hostname) []:
Email Address []:
Step 4
Enter the country name, state or province name, locality name, organization name, organizational unit name, common
name, and email address, and press Enter.
The following information is displayed:
Please enter the following 'extra' attributes
to be sent with your certificate request
A challenge password []:
An optional company name:
Step 5
(Optional) Enter a challenge password and an optional company name, and press Enter.
The following information is displayed:
Writing new CSR (Certificate Signing Request) to /opt/certs/localdom.csr.
Use the CSR to obtain a certificate in PEM format from a CA (Certificate Authority).
Writing new self-signed certificate in PEM format to opt/certs/localdom.pem.
Press return to continue ...
Cisco UCS Director Shell Guide, Release 5.3
23
Using Shell Commands
Importing Certification Authority or Self-Signed Certificates
Importing Certification Authority or Self-Signed Certificates
You can either import the generated self-signed certificate or import a certificate generated by another system
or third party by copying .pem and .key (private key) files to the /opt/certs/ directory. The shell admin
will automatically discover the .pem and .key files for the given domain in the /opt/certs/ directory.
The .pem file provided is exported into PKCS12 format, and then converted to JKS format. The JKS file can
be imported into Tomcat.
You can import a CA signed certificate or self-signed certificate using the Importing CA/Self-Signed Certificate
option.
Step 1
From the Cisco UCS Director Shell Menu choose the Importing CA/Self-Signed Certificate option and press Enter.
The following information is displayed:
Domain Name [localdom]:
Step 2
Enter the domain name and press Enter.
By default the shell menu will select the domain name of the local appliance that is configured.
The following information is displayed:
Enter CA/self-signed certificate [/opt/certs/localdom.pem]:
Step 3
Enter the path to the CA signed certificate or self-signed certificate, and press Enter.
The following information is displayed:
Enter private key [/opt/certs/localdom.key]:
Step 4
Enter the path to the private key and press Enter.
The following information is displayed:
Enter keystore password:
Step 5
Enter the Java KeyStore (JKS) password and press Enter.
Information similar to the following is displayed
Exporting /opt/certs/localdom.pem to PKCS12 format....
Converting PKCS12 to JKS format...
Importing /opt/certs/keystore.jks into tomcat for secured access to UCSD UI using HTTPS.
Certificate /opt/certs/keystore.jks imported to tomcat succesfully.
Do you want to import the certificate file:///opt/certs/localdom.pem into WebProxy for secured access
to VM console through VNC [y/n]?:
Step 6
Enter y and press Enter to import the certificate file into WebProxy for secured access to the VM console through VNC.
The following information is displayed:
Certificate file:///opt/certs/localdom.pem imported to WebProxy succesfully.
Press return to continue ...
Cisco UCS Director Shell Guide, Release 5.3
24
Using Shell Commands
Accessing Root Privileges
Accessing Root Privileges
This section describes how to access root. Tasks that require root privileges include moving directories or
files into other directories, providing or revoking user privileges, general system repairs, and occasionally
installing applications.
Note
Compiling software as root is not recommended for security reasons.
Configuring Root Access
You can enable root privileges by choosing Manage Root Access.
Step 1
From the Cisco UCS Director Shell choose Manage Root Access and press Enter.
The following information is displayed:
Enable/Disable/Configure (root privalege) [e/d/c]:
Step 2
Enter c and press Enter.
The following information is displayed:
Do you want to Configure/Set Root Privilege/Password [y/n]? :
Step 3
Enter y and press Enter.
The following information is displayed:
Changing root password...
Changing password for user root.
New UNIX password:
Step 4
Enter a new UNIX password and press Enter.
The following information is displayed:
Step 5
Enter your new UNIX password and press Enter.
The following information displays:
Retype new UNIX password:
passswd: all authentication tokens updated successfully.
Root passwd changed successfully
Press return to continue...
Step 6
Press Enter to complete the process.
Enabling Root Access
You can enable root privileges by choosing Manage Root Access.
Step 1
From the Cisco UCS Director Shell Menu choose the Manage Root Access option and press Enter.
The following information displays:
Enable/Disable/Configure (root privalege) [e/d/c]:
Cisco UCS Director Shell Guide, Release 5.3
25
Using Shell Commands
Disabling Root Access
Step 2
Enter e and press Enter.
The following information is displayed:
Do you want to Enable Root Access [y/n]? :
Step 3
Enter y and press Enter.
The following information is displayed:
Enabling root access...
Unlocking password for user root.
passwd: Success.
Root access enabled successfully
Press return to continue
Step 4
Press Enter to return to compete the process.
Disabling Root Access
Choose this option to disable root privileges.
Step 1
From the Cisco UCS Director Shell menu choose the Manage Root Access option and press the Enter key.
The following information displays:
Enable/Disable/Configure (root privalege) [e/d/c]:
Step 2
Enter d and press the Enter key.
The following information displays:
Do you want to Disable Root Access [y/n]? :
Step 3
Enter y and press the Enter key.
The following information is displayed:
disabling root access...
Locking password for user root.
Passwd: Success
Root access disabled sucessfully
Press return to continue...
Step 4
Press the Enter key to return to the main menu.
Logging in as Root
You can login in as root by choosing the Login As Root option.
Step 1
From the Cisco UCS Director Shell Menu choose the Login As Root option and press Enter.
The following information is displayed:
Do you want to
Step 2
Login As Root [y/n]? :
Enter y and press Enter.
Cisco UCS Director Shell Guide, Release 5.3
26
Using Shell Commands
Logging in as Root
The following information is displayed:
Logging in as root
password:
Step 3
Enter your root password and press Enter.
The following information is displayed:
Logging as root
Password:
[root@localhost shelladmin]#
Step 4
Step 5
Enter your password and press Enter.
Enter exit to return to the shelladmin.
Information similar to the following is displayed:
[root@localhost shelladmin]# cd /opt
[root@localhost opt]# exit
exit
Sucessful login
Press return to continue ...
Cisco UCS Director Shell Guide, Release 5.3
27
Using Shell Commands
Logging in as Root
Cisco UCS Director Shell Guide, Release 5.3
28
CHAPTER
4
Configuring a Multi-Node Setup
This chapter contains the following sections:
• About the Multi-Node Setup, page 29
• Minimum System Requirements for a Multi-Node Setup, page 31
• Guidelines and Limitations for a Multi-Node Setup, page 38
• Best Practices for a Multi-Node Setup, page 39
• Summary of Steps for Configuring a Multi-Node Setup, page 39
• Creating the Inventory Database, page 40
• Creating the Monitoring Database, page 41
• Creating the Primary Node, page 41
• Creating a Service Node, page 42
• System Tasks, page 43
• Backing Up with a Multi-Node Setup, page 47
• Restoring with a Multi-Node Setup, page 48
• Removing a Service Node, page 49
• Options for Migrating from a Standalone Appliance to a Multi-Node Setup, page 49
About the Multi-Node Setup
The multi-node setup is supported for Cisco UCS Director on a 64-bit operating system only. With a multi-node
setup, you can scale Cisco UCS Director to support a larger number of VMs than is supported by a single
installation of Cisco UCS Director. This setup includes the following nodes:
• One primary node
• One or more service nodes
• One monitoring database
Cisco UCS Director Shell Guide, Release 5.3
29
Configuring a Multi-Node Setup
About the Multi-Node Setup
• One inventory database
Figure 1: Multi-Node Topology
Note
For a multi-node setup, you have to install the license on the primary node only.
A multi-node setup improves scalability by offloading the processing of system tasks, such as inventory data
collection, from the primary node to one or more service nodes. You can assign certain system tasks to one
or more service nodes. The number of nodes determines how the processing of system tasks are scaled.
Node pools combine service nodes into groups and enable you to assign system tasks to more than one service
node. This provides you with control over which system task is executed by which service node or group of
service nodes. If you have multiple service nodes in a node pool and one of the service nodes is busy when a
system task needs to be run, Cisco UCS Director uses a round-robin assignment to determine which service
node should process that system task. if all service nodes are busy, you can have the primary node run the
system task.
However, if you do not need that level of control over the system tasks, you can use the default task policy
and add all of the service nodes to the default node pool. All system tasks are already associated with the
default task policy, and the round-robin assignment will be used to determine which service node should
process a system task.
If you want to have some critical tasks processed only by the primary node, you can assign those tasks to a
local-run policy.
For more information about how to configure the primary node and service nodes, and how to assign system
tasks, see the Cisco UCS Director Administration Guide.
Cisco UCS Director Shell Guide, Release 5.3
30
Configuring a Multi-Node Setup
Primary Node
Primary Node
A multi-node setup can have only one primary node. This primary node contains the license for Cisco UCS
Director.
The primary node also contains the configuration for the node pools and the service nodes, along with the list
of which system tasks can be offloaded to the service nodes for processing.
Service Nodes
A multi-node setup can have one or more service nodes. The number of service nodes in a multi-node setup
depends upon the number of devices and VMs you plan to configure and manage through Cisco UCS Director.
Database Nodes
The inventory and monitoring databases are created from the Cisco UCS Director MySQL database. The data
that Cisco UCS Director collects is divided between the two databases. The multi-node setup segregates the
data collection which is historically very heavy on the database into a separate database.
Inventory Database
A multi-node setup can have only one inventory database. This database contains the following:
• Physical and virtual accounts and their related inventory data
• Data used in the normal operation of Cisco UCS Director for all supported features
Monitoring Database
A multi-node setup can have only one monitoring database. This database contains the data that Cisco UCS
Director uses for historical computations, such as aggregations and trend reports.
The parameters of the monitoring database depend upon the number of devices and VMs you plan to configure
and manage through Cisco UCS Director
Minimum System Requirements for a Multi-Node Setup
The minimum system requirements for a multi-node setup depends upon the number of VMs that need to be
supported by Cisco UCS Director. The following table describes the number of VMs supported by each
deployment size.
Deployment Size
Number of VMs Supported
Small
5,000 to 10,000 VMs
Medium
10,000 to 20,000 VMs
Large
20,000 to 50,000 VMs
Cisco UCS Director Shell Guide, Release 5.3
31
Configuring a Multi-Node Setup
Minimum System Requirements for a Small Multi-Node Setup
Minimum System Requirements for a Small Multi-Node Setup
The small multi-node setup supports from 5,000 to 10,000 VMs. We recommend that this deployment include
the following nodes:
• One primary node
• Two service nodes
• One inventory database
• One monitoring database
Note
For optimal performance, reserve additional CPU and memory resources.
Minimum Requirements for each Primary Node and Service Node
Element
Minimum Supported Requirement
vCPU
4
Memory
16 GB
Hard disk
100 GB
Minimum Requirements for the Inventory Database
Element
Minimum Supported Requirement
vCPU
4
Memory
30 GB
Hard disk
100 GB (SSD Type Storage)
Minimum Requirements for the Monitoring Database
Element
Minimum Supported Requirement
vCPU
4
Memory
30 GB
Hard disk
100 GB (SSD Type Storage)
Cisco UCS Director Shell Guide, Release 5.3
32
Configuring a Multi-Node Setup
Minimum System Requirements for a Medium Multi-Node Setup
Minimum Memory Configuration for Cisco UCS Director Services on Primary and Service Nodes
Service
Recommended
Configuration
File Location
Parameter
broker
512 MB
/opt/infra/broker/run.sh
-Xms -Xmx
client
512 MB
/opt/infra/client/run.sh
-Xms -Xmx
controller
512 MB
/opt/infra/controller/run.sh
-Xms -Xmx
eventmgr
512 MB
/opt/infra/eventmgr/run.sh
-Xms -Xmx
idaccessmgr
512 MB
/opt/infra/idaccessmgr/run.sh
-Xms -Xmx
inframgr
8 GB
/opt/infra/inframgr/run.sh
-Xms -Xmx
Tomcat
2 GB
/opt/infra/web_cloudmgr/apache-tomcat JAVA_OPTS="$JAVA_OPTS
-Xmsm -Xmxm"
/bin/catalina.sh
Minimum Configuration for the Inventory and Monitoring Databases
Component
Minimum Supported Configuration
thread_cache_size
1000
max_connections
1000
innodb_lock_wait_timeout
100
query_cache_size
128 MB
innodb_buffer_pool_size
24576 MB
max_connect_errors
10,000
connect_timeout
20
innodb_read_io_threads
64
innodb_write_io_threads
64
Minimum System Requirements for a Medium Multi-Node Setup
The medium multi-node setup supports between 10,000 and 20,000 VMs. We recommend that this deployment
include the following nodes:
• One primary node
Cisco UCS Director Shell Guide, Release 5.3
33
Configuring a Multi-Node Setup
Minimum System Requirements for a Medium Multi-Node Setup
• Three service nodes
• One inventory database
• One monitoring database
Note
For optimal performance, reserve additional CPU and memory resources.
Minimum Requirements for each Primary Node and Service Node
Element
Minimum Supported Requirement
vCPU
8
Memory
30 GB
Hard disk
100 GB
Minimum Requirements for the Inventory Database
Element
Minimum Supported Requirement
vCPU
8
Memory
60 GB
Hard disk
100 GB (SSD type storage)
Minimum Requirements for the Monitoring Database
Element
Minimum Supported Requirement
vCPU
8
Memory
60 GB
Hard disk
100 GB (SSD type storage)
Minimum Memory Configuration for Cisco UCS Director Services on Primary and Service Nodes
Service
Recommended
Configuration
File Location
Parameter
broker
1 GB
/opt/infra/broker/run.sh
-Xms -Xmx
Cisco UCS Director Shell Guide, Release 5.3
34
Configuring a Multi-Node Setup
Minimum System Requirements for a Medium Multi-Node Setup
Service
Recommended
Configuration
File Location
Parameter
client
1 GB
/opt/infra/client/run.sh
-Xms -Xmx
controller
1 GB
/opt/infra/controller/run.sh
-Xms -Xmx
eventmgr
256 MB
/opt/infra/eventmgr/run.sh
-Xms -Xmx
idaccessmgr
1 GB
/opt/infra/idaccessmgr/run.sh
-Xms -Xmx
inframgr
12 GB
/opt/infra/inframgr/run.sh
-Xms -Xmx
Tomcat
4 GB
/opt/infra/web_cloudmgr/apache-tomcat JAVA_OPTS="$JAVA_OPTS
-Xmsm -Xmxm"
/bin/catalina.sh
Minimum Inventory Database Configuration
Component
Minimum Supported Configuration
thread_cache_size
2000
max_connections
2000
innodb_lock_wait_timeout
100
query_cache_size
128 MB
innodb_buffer_pool_size
43,008 MB
max_connect_errors
10,000
connect_timeout
20
innodb_read_io_threads
64
innodb_write_io_threads
64
Minimum Monitoring Database Configuration
Component
Minimum Supported Configuration
thread_cache_size
2000
max_connections
2000
innodb_lock_wait_timeout
100
Cisco UCS Director Shell Guide, Release 5.3
35
Configuring a Multi-Node Setup
Minimum System Requirements for a Large Multi-Node Setup
Component
Minimum Supported Configuration
query_cache_size
128 MB
innodb_buffer_pool_size
43,008 MB
max_connect_errors
10,000
connect_timeout
20
innodb_read_io_threads
64
innodb_write_io_threads
64
Minimum System Requirements for a Large Multi-Node Setup
The large multi-node setup supports between 20,000 and 50,000 VMs. We recommend that this deployment
include the following nodes:
• One primary node
• Six service nodes
• One inventory database
• One monitoring database
Note
For optimal performance, reserve additional CPU and memory resources.
Minimum Requirements for each Primary Node and Service Node
Element
Minimum Supported Requirement
vCPU
8
Memory
60 GB
Hard disk
100 GB
Minimum Requirements for the Inventory Database
Element
Minimum Supported Requirement
vCPU
8
Memory
120 GB
Cisco UCS Director Shell Guide, Release 5.3
36
Configuring a Multi-Node Setup
Minimum System Requirements for a Large Multi-Node Setup
Element
Minimum Supported Requirement
Hard disk
200 GB (SSD type storage)
Minimum Requirements for the Monitoring Database
Element
Minimum Supported Requirement
vCPU
8
Memory
120 GB
Hard disk
600 GB (SSD type storage)
Minimum Memory Configuration for Cisco UCS Director Services on Primary and Service Nodes
Service
Recommended
Configuration
File Location
Parameter
broker
2 GB
/opt/infra/broker/run.sh
-Xms -Xmx
client
2 GB
/opt/infra/client/run.sh
-Xms -Xmx
controller
2 GB
/opt/infra/controller/run.sh
-Xms -Xmx
eventmgr
256 MB
/opt/infra/eventmgr/run.sh
-Xms -Xmx
idaccessmgr
2 GB
/opt/infra/idaccessmgr/run.sh
-Xms -Xmx
inframgr
24 GB
/opt/infra/inframgr/run.sh
-Xms -Xmx
Tomcat
8 GB
/opt/infra/web_cloudmgr/apache-tomcat JAVA_OPTS="$JAVA_OPTS
-Xmsm -Xmxm"
/bin/catalina.sh
Minimum Inventory Database Configuration
Component
Minimum Supported Configuration
thread_cache_size
4000
max_connections
4000
innodb_lock_wait_timeout
100
query_cache_size
128 MB
Cisco UCS Director Shell Guide, Release 5.3
37
Configuring a Multi-Node Setup
Guidelines and Limitations for a Multi-Node Setup
Component
Minimum Supported Configuration
innodb_buffer_pool_size
86,016 MB
max_connect_errors
10,000
connect_timeout
20
innodb_read_io_threads
64
innodb_write_io_threads
64
Minimum Monitoring Database Configuration
Component
Minimum Supported Configuration
thread_cache_size
4000
max_connections
4000
innodb_lock_wait_timeout
100
query_cache_size
128 MB
innodb_buffer_pool_size
86,016 MB
max_connect_errors
10,000
connect_timeout
20
innodb_read_io_threads
64
innodb_write_io_threads
64
Guidelines and Limitations for a Multi-Node Setup
Before you configure a multi-node setup for Cisco UCS Director, consider the following:
• The multi-node setup is supported for Cisco UCS Director on a 64-bit operating system only.
• Your multi-node setup can have only one primary node.
• You must plan the location and IP addresses of your nodes carefully as you cannot reconfigure the types
of most nodes later. You can only reconfigure a service node as a primary node. You cannot make any
other changes to the type of node. For example, you cannot reconfigure a primary node as a service node
or an inventory database node as a monitoring database node.
• You have to install the license on the primary node only.
Cisco UCS Director Shell Guide, Release 5.3
38
Configuring a Multi-Node Setup
Best Practices for a Multi-Node Setup
• After you configure the nodes, the list of operations available in the shelladmin changes for the service
nodes, the inventory database node, and the monitoring database node.
Best Practices for a Multi-Node Setup
Before you configure a multi-node setup for Cisco UCS Director, consider the following best practices:
• To maximize output and minimize network latency, we recommend that the primary node, service nodes,
inventory database nodes, and monitoring database nodes reside on the same host.
• The primary node, inventory database nodes, and monitoring database nodes can reside on the same
host, network or physical location, and the service nodes can reside on another network or physical
location, as long as the primary nodes and service nodes are accessible by the databases.
• We recommend that you assess the network latency as part of your multi-node deployment plan and
place a service node closer to the physical and virtual infrastructures, and associate any relevant system
tasks to run on the local service nodes. The primary node handles offloading the execution of system
tasks to the appropriate service node.
• You can offload system tasks to available service nodes by associating the service nodes with a service
node pool.
Summary of Steps for Configuring a Multi-Node Setup
This procedure provides a high-level summary of the steps involved in configuring a multi-node setup.
Note
Step 1
Plan your multi-node setup carefully. You can only change a service node to a primary node. You cannot
change any other type of node after you configure it. For example, you cannot reconfigure a primary node
as a service node or an inventory database node as a monitoring database node.
Deploy a Cisco UCS Director VM for each node in the multi-node setup.
See Installing Cisco UCS Director on VMware vSphere.
For example, if your multi-node setup, includes a primary node, an inventory database, a monitoring database, and three
service nodes, deploy six Cisco UCS Director VMs.
Step 2
In the Cisco UCS Director shelladmin, configure the nodes in the following order:
1 Creating the Inventory Database, on page 40
2 Creating the Monitoring Database, on page 41
3 Creating the Primary Node, on page 41
4 Creating a Service Node, on page 42
Note
You must create and start the inventory database and the monitoring database nodes before you configure the
primary node and any service nodes.
Cisco UCS Director Shell Guide, Release 5.3
39
Configuring a Multi-Node Setup
Creating the Inventory Database
Step 3
Update the license file in the Cisco UCS Director node that will be the primary node.
You do not need to update the license file on any other node.
See Updating the License.
Step 4
In Cisco UCS Director on the primary node, configure the system tasks as follows:
a) Create one or more node pools if you want to control the assignment of system tasks by service node, or accept the
default node pool.
See Creating a Node Pool, on page 44.
b) Create one or more system task policies if you want to control the assignment of system tasks by service node, or
accept the default task policy.
See Creating System Task Policy, on page 44.
c) Configure the service nodes.
d) Configure the primary node.
e) Assign the system tasks to system policies if you want to control the assignment of system tasks by service node.
See Assigning a System Policy to a System Task, on page 46.
For more information, see System Tasks, on page 43.
Creating the Inventory Database
Step 1
Step 2
Log into the Cisco UCS Director shelladmin on the inventory database node.
From the Cisco UCS Director Shell menu, choose Configure Multi-Node Setup and press Enter.
Step 3
From the menu, choose Configure Multi Node Setup (Advanced Deployment) and press Enter.
Step 4
Step 5
Step 6
When prompted, press 1 to configure the current node.
When prompted, press y and then select the option to configure the node as the inventory database node.
From the menu, choose Configure Inventory Database and press Enter.
Step 7
Step 8
When prompted, press Enter to continue.
To verify that the services for the inventory database are up and running, choose Display Services Status and
press Enter.
You should see the following lines:
2838 ?
3172 ?
00:00:00 mysqld_safe
3-02:51:38 mysqld
After you return to the shelladmin, the menu options change to those available for an inventory database node.
Cisco UCS Director Shell Guide, Release 5.3
40
Configuring a Multi-Node Setup
Creating the Monitoring Database
Creating the Monitoring Database
Step 1
Step 2
Log into the Cisco UCS Director shelladmin on the monitoring database node.
From the Cisco UCS Director Shell menu, choose Configure Multi-Node Setup and press Enter.
Step 3
From the menu, choose Configure Multi Node Setup (Advanced Deployment) and press Enter.
Step 4
Step 5
Step 6
When prompted, press 1 to configure the current node.
When prompted, press y and then select the option to configure the node as the monitoring database node.
From the menu, choose Configure Monitoring Database and press Enter.
Step 7
Step 8
When prompted, press Enter to continue.
To verify that the services for the monitoring database are up and running, choose Display Services Status
and press Enter.
You should see the following lines:
2838 ?
3172 ?
00:00:00 mysqld_safe
3-02:51:38 mysqld
After you return to the shelladmin, the menu options change to those available for a monitoring database node.
Creating the Primary Node
Before You Begin
The inventory and monitoring databases must be up and running before you create the primary node.
Note
Do not run any daemons on the primary database.
Step 1
Step 2
Log into the Cisco UCS Director shelladmin on the primary node.
From the Cisco UCS Director Shell menu, choose Configure Multi-Node Setup and press Enter.
Step 3
From the menu, choose Configure Multi Node Setup (Advanced Deployment) and press Enter.
Step 4
Step 5
Step 6
When prompted, press 1 to configure the current node.
When prompted, press y and then select the option to configure the node as the primary node.
From the menu, choose Configure Primary Node and press Enter.
Step 7
At the Provide Inventory DB IP prompt, enter the IP address assigned to the Cisco UCS Director VM for the inventory
database.
This step registers the VM as a primary node with the inventory database.
Cisco UCS Director Shell Guide, Release 5.3
41
Configuring a Multi-Node Setup
Creating a Service Node
Step 8
At the Provide Monitoring DB IP prompt, enter the IP address assigned to the Cisco UCS Director VM for the monitoring
database.
This step registers the VM as a primary node with the monitoring database.
Step 9
Step 10
When prompted, press Enter to continue.
To verify that the services for the primary node are up and running, choose Display Services Status and press
Enter.
You should see the following lines:
Service
---------broker
controller
eventmgr
client
idaccessmgr
inframgr
TOMCAT
websock
Status
---------RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
PID
----25677
25715
25749
25808
25854
25911
25967
26009
Node Type : primary
Inventory DB( 172.29.109.135:3306 ) status
Monitor DB( 172.29.109.144:3306 ) status : UP
Press return to continue ...
: UP
After you return to the shelladmin, the menu options change to those available for a primary node.
Creating a Service Node
Before You Begin
The inventory and monitoring databases must be up and running before you create the primary node.
Step 1
Step 2
Log into the Cisco UCS Director shelladmin on the service node.
From the Cisco UCS Director Shell menu, choose Configure Multi-Node Setup and press Enter.
Step 3
From the menu, choose Configure Multi Node Setup (Advanced Deployment) and press Enter.
Step 4
Step 5
Step 6
When prompted, press 1 to configure the current node.
When prompted, press y and then select the option to configure the node as the secondary node.
From the menu, choose Configure Service Node and press Enter.
Step 7
At the Provide Inventory DB IP prompt, enter the IP address assigned to the Cisco UCS Director VM for the inventory
database.
This step registers the VM as a service node with the inventory database.
Cisco UCS Director Shell Guide, Release 5.3
42
Configuring a Multi-Node Setup
System Tasks
Step 8
At the Provide Monitoring DB IP prompt, enter the IP address assigned to the Cisco UCS Director VM for the monitoring
database.
This step registers the VM as a service node with the monitoring database.
Step 9
Step 10
When prompted, press Enter to continue.
To verify that the services for the service node are up and running, choose Display Services Status and press
Enter.
You should see the following lines:
Service
---------broker
controller
eventmgr
client
idaccessmgr
inframgr
TOMCAT
websock
Status
---------RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
RUNNING
PID
----25677
25715
25749
25808
25854
25911
25967
26009
Node Type : service
Inventory DB( 172.29.109.135:3306 ) status
Monitor DB( 172.29.109.144:3306 ) status : UP
Press return to continue ...
: UP
After you return to the shelladmin, the menu options change to those available for a service node.
Step 11
Repeat this procedure for every service node.
System Tasks
The System Tasks tab displays all the system tasks that are currently available in Cisco UCS Director.
However, this list of system tasks is linked to the type of accounts that you have created in Cisco UCS Director.
For example, if you have logged in for the first time, then only a set of general system-related tasks or VMware
related tasks are visible on this page. As and when you add accounts, such as rack accounts, or Cisco UCS
Manager accounts, system tasks related to these accounts are populated on this page.
Following are the tasks that you can complete from the System Tasks page:
• View the available systems tasks—You can use the Expand and Collapse options to view all the system
tasks that are available on this page. The tasks are categorized according to the accounts available in
Cisco UCS Director. For example: Cisco UCS Tasks, NetApp Tasks and so on.
• Disable and enable system tasks—In circumstances when there are multiple processes or tasks running
on the appliance, you can choose to disable a system task. If you do so, then until such time that you
manually enable it, the system task will not run. This will affect the data that is populated in other reports.
For example, if you disable an inventory collection system task, then reports that require this data may
not display accurate data. In this case, you will have to manually run an inventory collection process,
or enable the system task.
Cisco UCS Director Shell Guide, Release 5.3
43
Configuring a Multi-Node Setup
Creating a Node Pool
For more information, see Disabling or Enabling a System Task, on page 47.
In a single node setup, where there is only one server, all system tasks will run on this server. In a multi-node
setup, where there are multiple servers configured, all system tasks, by default, run on the primary server.
However, you can specify system tasks to run on the secondary servers. Following is the recommended steps
to perform this task:
1 Ensure that the secondary servers are available in Cisco UCS Director as nodes. If the servers are not
available, then you must add the servers as nodes. For more information, see Creating a Service Node,
on page 45.
2 Create a node pool from the available servers. For more information, see Creating a Node Pool, on page
44.
3 Create a system task policy, and associate it with a node policy. For more information, see Creating System
Task Policy, on page 44.
4 Associate a node pool with the system task policy. For more information, see Assigning a Node Pool to
System Task Policy, on page 45.
5 Select a system task, and associate it with a system-task policy. For more information, see Assigning a
System Policy to a System Task, on page 46.
Creating a Node Pool
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
On the menu bar, choose Administration > System.
Choose the Service Nodes tab.
Click the Service Node Pools icon. The Service Node Pool dialog box displays.
Click the + (plus) icon. The Add Entry to Service Node Pools dialog box displays.
In the Name field, enter the node pool name.
(Optional) In the Description field, enter a description of the node pool name.
Click Submit. The node pool is created.
Creating System Task Policy
You can group system tasks into a system task policy to later determine which system tasks are running on
which node.
Cisco UCS Director Shell Guide, Release 5.3
44
Configuring a Multi-Node Setup
Assigning a Node Pool to System Task Policy
Note
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
A new system task policy is created when an administrator decides when one or more policies are needed
in addition to the default system task policy.
On the menu bar, choose Administration > System.
Choose the System Task Policy tab.
Click the Add icon. The Add dialog box displays.
In the Name field, enter the name that you gave the system task policy.
(Optional) In the Description field, enter a description of the system task policy.
From the Node Pool drop-down list, choose the node pool to which this system task policy belongs.
Click Submit. The selected node pool now belongs to the newly created system task policy.
Assigning a Node Pool to System Task Policy
Step 1
Step 2
Step 3
Step 4
Step 5
On the menu bar, choose Administration > System.
Choose the System Task Policy tab.
Select an existing system task policy from the Name column and click the Edit icon. The Edit dialog box displays.
Note
If the default system task policy is used, you can assign service nodes to this policy. See the Creating System
Task Policy, on page 44 section, if you want to configure a policy that is different from the default.
Select a node pool to which this System Task Policy belongs from the Node Pool drop-down list, choose the node pool
to which this system task policy belongs.
Click Submit. The selected node pool now belongs to the system task policy.
Creating a Service Node
Step 1
Step 2
Step 3
Step 4
On the menu bar, choose Administration > System.
Choose the Service Nodes tab.
Click the Add (+)
In the Service Node dialog box, complete the following fields:
Name
Description
Node Name field
Enter the name of the service node.
Cisco UCS Director Shell Guide, Release 5.3
45
Configuring a Multi-Node Setup
Assigning a System Policy to a System Task
Name
Description
Role field
Service is described as the role of this node.
Service Node Pool drop-down list
The default-service-node-pool is chosen.
DNS Name field
Description field
Enter either the DNS name or IP address of the service
node.
Note
This field cannot use the Primary Node’s IP
address. Ensure that a valid Service Node DNS
name or IP address is entered.
The description of the of the service node.
Protocol drop-down list
Choose either http (default) or https.
Port field
The default TCP port for the Hypertext Transfer Protocol
(HTTP) 80 is entered by default. Enter a different TCP port
if necessary.
UserName field
The infraUser user name is entered by default. The
infraUser is a user account created by default. To find this
user account on the menu bar, choose Administration>
Users and Groups. Choose the Login Users tab to find
the infraUser user account in the Login Name column.
The InfraUser user name is not the default
administrator user to login to the UCS Director
system itself.
Another user name can be added to this field. This user’s
API key is used to authenticate with the Service Node.
Note
Step 5
Click Submit.
Assigning a System Policy to a System Task
Step 1
Step 2
Step 3
On the menu bar, choose Administration > System.
Choose the System Task tab.
Choose a folder that contains system task(s). Click the folder arrow to expand its tasks.
Note
128 system tasks are
available.
Cisco UCS Director Shell Guide, Release 5.3
46
Configuring a Multi-Node Setup
Executing System Tasks
Step 4
Choose the task and click the Manage Task icon. The Manage Task dialog box displays.
Step 5
Step 6
Step 7
From the Task Execution drop-down list, choose Enable.
From the System Task Policy drop-down list, choose a system policy.
Click Submit. The system task is assigned to the selected system policy.
Executing System Tasks
Note
Step 1
Step 2
Step 3
Step 4
There are few system tasks that cannot be run remotely on the service node. You can also assign a system
policy remotely from the local host or primary node.
On the menu bar, choose Administration > System.
Choose the System Tasks tab
Choose a task from the list.
Click Run Now. The selected task updates its information.
Disabling or Enabling a System Task
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
On the menu bar, choose Administration > System.
Choose the System Task tab.
Choose a folder that contains system task(s). Click the folder arrow to expand its tasks.
Note
128 system tasks are
available.
Choose the task and click the Manage Task icon. The Manage Task dialog box displays.
To disable a system task, from the Task Execution drop-down list, choose Disable.
To enable a system task, from the Task Execution drop-down list, choose Enable.
Click Submit.
Backing Up with a Multi-Node Setup
This procedure provides a high-level summary of the steps required to back up a multi-node setup.
Cisco UCS Director Shell Guide, Release 5.3
47
Configuring a Multi-Node Setup
Restoring with a Multi-Node Setup
The backup procedure requires you to first stop the Cisco services. This must be done before you work with
the Monitoring and Inventory databases. Then you back up the databases, after which you re-start the services,
starting with the Primary node.
Before You Begin
To back up the databases, you use an FTP server, for which you will need:
• An FTP server account and the IP address
• The FTP server's login credentials
• Backup file name(s)
SUMMARY STEPS
1. Shut down the services for both the Primary and Service nodes. Use the, Stop Services Shell potion.
2. Back up the Monitoring database. Use the Backup Database Shell option.
3. Backup the Inventory database. Use the Backup Database Shell option.
4. Start the Services (Service nodes first, followed by Primary node). Use the Start Services Shell option.
DETAILED STEPS
Step 1
Step 2
Step 3
Step 4
Shut down the services for both the Primary and Service nodes. Use the, Stop Services Shell potion.
Back up the Monitoring database. Use the Backup Database Shell option.
Backup the Inventory database. Use the Backup Database Shell option.
Start the Services (Service nodes first, followed by Primary node). Use the Start Services Shell option.
Restoring with a Multi-Node Setup
This procedure provides a high-level summary of the steps required to restore a multi-node setup.
The restore procedure requires you to first stop the Cisco services. This must be done before you work with
the Monitoring and Inventory databases. Then you restore the databases, after which you re-start the services,
starting with the Primary node.
Before You Begin
To restore the databases, you use an FTP server, for which you will need:
• An FTP server account and the IP address
• The FTP server's login credentials
• Backup file name(s)
Cisco UCS Director Shell Guide, Release 5.3
48
Configuring a Multi-Node Setup
Removing a Service Node
SUMMARY STEPS
1.
2.
3.
4.
Shut down the services for both the Primary and Service nodes. Use Shell option 3, Stop Services.
Restore the Monitoring database. Use the Shell Restore Database option.
Restore the Inventory database. Use the Shell Restore Database option.
Start the Services (Service nodes first, followed by Primary node). Use Shell option 4, Start Services.
DETAILED STEPS
Step 1
Step 2
Step 3
Step 4
Shut down the services for both the Primary and Service nodes. Use Shell option 3, Stop Services.
Restore the Monitoring database. Use the Shell Restore Database option.
Restore the Inventory database. Use the Shell Restore Database option.
Start the Services (Service nodes first, followed by Primary node). Use Shell option 4, Start Services.
Removing a Service Node
This procedure provides a high-level summary of the steps required to remove a service node from a multi-node
setup.
The removal procedure requires you to first stop the Cisco services. This must be done before you remove a
service node from Monitoring and Inventory databases.
Step 1
Step 2
Step 3
Step 4
Shut down the services for both the Primary node and the Service node(s). Use Shell option 3, Stop Services.
Start the services on the Service node(s) that you want to be active and operational. Use Shell option 4, Start Services.
Start the services on the Primary node. Use Shell option 4, Start Services.
Using the Cisco UCS Director GUI, delete the Service node that you want to remove.
This removes the respective Service node from the database.
Options for Migrating from a Standalone Appliance to a
Multi-Node Setup
All requirements and configuration for a multi-node setup must be completed before you attempt to migrate
from a standalone appliance to a multi-node setup. Please refer to the requirements and instructions pertaining
to the multi-node setup you are planning to implement before proceeding.
Refer to the most recent Release Notes and ReadMe file for up-to-date information about support for migrating
from a previous release of a Cisco UCS Director standalone appliance to a multi-node setup on the current
release. Single to multi-node migration from some earlier releases to the current release may not be supported.
For more information on supported migration paths, see the Upgrading Cisco UCS Director chapter.
Cisco UCS Director Shell Guide, Release 5.3
49
Configuring a Multi-Node Setup
Migrating a Release 4.0 Standalone Appliance to a Multi-Node Setup with a Full Database Backup
Note
You must upgrade to Cisco UCS Director, Release 4.0 or later, before you can migrate to a multi-node
setup and backup the database.
You can choose between the following options for migrating a Cisco UCS Director standalone appliance to
a multi-node setup:
• You restore a backup of the entire database from Cisco UCS Director, Release 4.0, to the Cisco UCS
Director, Release 4.1 monitoring database and inventory database nodes. This option is similar to the
database backup and restore you can perform through shelladmin.
• You back up the database from Cisco UCS Director, Release 4.0, separately for the inventory database
and monitoring database nodes. If you choose this option, only selected database tables are backed up
and restored to the monitoring and inventory databases. This option requires you to execute custom
scripts from /opt/infra.
• You perform a back up that involves using custom scripts twice, once for the inventory database and
once for the Monitor database. The backed up databases will have tables that are built selectively for
the node type. You then copy the backed up appliance file to the relevant node and execute the custom
script again. But this time you execute the script in each Inventory and Monitor node.
Detailed instructions for these options follow in this section.
Migrating a Release 4.0 Standalone Appliance to a Multi-Node Setup with a
Full Database Backup
This procedure restores all database tables to the inventory database and the monitoring database.
Before You Begin
You must have an FTP server with valid credentials to perform a backup and restore of the database.
Step 1
In the shelladmin, upgrade the Cisco UCS Director, Release 4.0, standalone appliance to Cisco UCS Director, Release
4.1 with the Apply Patch option.
For more information, see the following:
• Upgrading from Cisco Unified Infrastructure Controller 3.x 32-bit to Cisco UCS Director, Release 4.1 64-bit
• Upgrading from Cisco UCS Director, Release 4.0 to Release 4.1
Step 2
In the shelladmin, choose Backup Database to backup the full database of the upgraded Cisco UCS Director.
Step 3
Deploy a Cisco UCS Director VM for each node in the multi-node setup.
For example, if your multi-node setup, includes a primary node, an inventory database, a monitoring database, and three
service nodes, deploy six Cisco UCS Director VMs.
Step 4
In the shelladmin, configure the nodes in the following order:
1 Creating the Inventory Database, on page 40
2 Creating the Monitoring Database, on page 41
Cisco UCS Director Shell Guide, Release 5.3
50
Configuring a Multi-Node Setup
Migrating a Release 4.0 Standalone Appliance to a Multi-Node Setup with a Selected Database Backup
3 Creating the Primary Node, on page 41
4 Creating a Service Node, on page 42
Step 5
You must create and start the inventory database and the monitoring database nodes before you configure the
primary node and any service nodes.
In the shelladmin, choose Stop services to stop the Cisco UCS Director services.
Step 6
Choose Restore database to import and restore the database backup that you took in Step 2.
Step 7
When prompted, choose Start services to start the Cisco UCS Director services.
After you log in to the primary node, all data from the database in the Cisco UCS Director, Release 4.0, standalone
appliance should be available.
Note
Migrating a Release 4.0 Standalone Appliance to a Multi-Node Setup with a
Selected Database Backup
This procedure backs up and restores only the selected database tables required for each of the inventory
database and the monitoring database.
Before You Begin
You must have an FTP server with valid credentials to perform a backup and restore of the database.
Step 1
In the shelladmin, upgrade the Cisco UCS Director, Release 4.0, standalone appliance to Cisco UCS Director, Release
4.1 with the Apply Patch option.
For more information, see the following:
• Upgrading from Cisco Unified Infrastructure Controller 3.x 32-bit to Cisco UCS Director, Release 4.1 64-bit
• Upgrading from Cisco UCS Director, Release 4.0 to Release 4.1
Step 2
In the shelladmin, choose Login as Root to log in to the upgraded Cisco UCS Director.
Step 3
Back up the database tables required for the inventory database, as follows:
a) Navigate to the /opt/infra folder.
cd /opt/infra
b) From Infra, run the dbInfraBackupRestore.sh script.
# ./dbInfraBackupRestore.sh backup
This script takes a database backup with the tables required for the inventory database.
c) After the script has been executed, check for an output file in /tmp folder named
infra_database_backup.tar.gz.
Step 4
Back up the database tables required for the monitoring database, as follows:
Cisco UCS Director Shell Guide, Release 5.3
51
Configuring a Multi-Node Setup
Migrating a Release 4.0 Standalone Appliance to a Multi-Node Setup with a Selected Database Backup
a) Navigate to the /opt/infra folder.
cd /opt/infra
b) From Infra, run the dbMonitoringBackupRestore.sh script.
# ./dbMonitoringBackupRestore.sh backup
This script takes a database backup with the tables required for the monitoring database.
c) After the script has been executed, check for an output file in /tmp folder named
monitoring_database_backup.tar.gz.
Step 5
Deploy a Cisco UCS Director VM for each node in the multi-node setup.
For example, if your multi-node setup, includes a primary node, an inventory database, a monitoring database, and three
service nodes, deploy six Cisco UCS Director VMs.
Step 6
In the shelladmin, configure the nodes in the following order:
1 Creating the Inventory Database, on page 40
2 Creating the Monitoring Database, on page 41
3 Creating the Primary Node, on page 41
4 Creating a Service Node, on page 42
You must create and start the inventory database and the monitoring database nodes before you configure the
primary node and any service nodes.
In the shelladmin, choose Stop services to stop the Cisco UCS Director services on the primary node and all service
nodes.
Restore the database to the inventory database, as follows:
a) Copy the infra_database_backup.tar.gz to the /tmp folder on the node that hosts the inventory database.
b) On the inventory database node, navigate to the /opt/infra folder.
Note
Step 7
Step 8
cd /opt/infra
c) From Infra, run the dbInfraBackupRestore.sh script.
# ./dbInfraBackupRestore.sh restore
The script restores the database backup from the backup file in the /tmp folder .
Step 9
Restore the database to the monitoring database, as follows:
a) Copy the monitoring_database_backup.tar.gz to the /tmp folder on the node that hosts the monitoring
database.
b) Navigate to the /opt/infra folder.
cd /opt/infra
Cisco UCS Director Shell Guide, Release 5.3
52
Configuring a Multi-Node Setup
Migrating a Release 4.1 Standalone Appliance to a Multi-Node Setup with Selective Database Table Backup
c) From Infra, run the dbMonitoringBackupRestore.sh script.
# ./dbMonitoringBackupRestore.sh restore
The script restores the database backup from the backup file in the /tmp folder .
Step 10
Choose Start services on the primary node and all service nodes to start the Cisco UCS Director services.
After you log in to the primary node, all data from the database in the Cisco UCS Director, Release 4.0, standalone
appliance should be available.
Migrating a Release 4.1 Standalone Appliance to a Multi-Node Setup with
Selective Database Table Backup
To perform this migration to a multiple node setup, your back up involves using custom scripts twice, once
for the inventory database and once for the Monitor database. The backed up databases have tables that are
built selectively for the node type. To restore to the multi-node setup, you copy the backed up appliance file
to the relevant node and execute the custom script again in each Inventory and Monitor node.
Steps for Backup and Restore for Standalone
Multi node
The DB backup step involves executing custom script which needs to be
executed twice, one for Inventory DB and other for Monitor DB.
The backed up DB will have selective tables that are relevant to the node type.
DB Backup
1st DB Backup for Inventory Node
- Login as root user
cd /opt/infra
From Infra execute the dbInfraBackupRestore.sh as shown below
#. /dbInfraBackupRestore.sh backup
This script will take a backup with necessary tables
for inventory node.
Once the script is executed, check for the output file
in /tmp folder with name as infra_database_backup.tar.gz
- 2nd DB Backup for Monitor Node
- Login as root user
cd /opt/infra
From Infra execute the dbMonitoringBackupRestore.sh as shown below
#. / dbMonitoringBackupRestore.sh backup
This script will take a backup with necessary tables for monitor node.
Once the script is executed, check for the output file in /tmp folder
with name as monitoring_database_backup.tar.gz
DB Restore
Stop services on Primary Node & Service Node. In case of more than
one Services nodes, Stop services on all the nodes.
To restore the DB on Inventory and Monitor node, user needs to
copy the backed up file from backup appliance to the relevant node.
After the files are placed on the nodes, user needs to execute the
custom script again. But this time the script needs to be
executed individually in each node (Inventory and Monitor nodes).
Cisco UCS Director Shell Guide, Release 5.3
53
Configuring a Multi-Node Setup
Migrating a Release 4.1 Standalone Appliance to a Multi-Node Setup with Selective Database Table Backup
- 1st DB Restore for Inventory Node
- Login as root user
Copy the backup file (infra_database_backup.tar.gz) from the backup
appliance to /tmp folder in the Inventory node appliance.
In the Inventory node appliance
cd /opt/infra
From Infra execute the dbInfraBackupRestore.sh as shown below
#. /dbInfraBackupRestore.sh restore
This script will restore the DB from backup file
(infra_database_backup.tar.gz) placed in /tmp folder.
- 2nd DB Restore for Monitor Node
- Login as root user
Copy the backup file (monitoring_database_backup.tar.gz) from the backup
appliance to /tmp folder in the Monitor node appliance.
In the Monitor node appliance
cd /opt/infra
From Infra execute the dbMonitoringBackupRestore.sh as shown below
#. / dbMonitoringBackupRestore.sh restore
This script will restore the DB from backup file
(monitoring_database_backup.tar.gz) placed in /tmp folder.
Before You Begin
Step 1
Start the database backup with the Inventory node.
a) Login as root user.
b) cd /opt/infra
c) From infra, execute the dbInfraBackupRestore.sh script as shown below.
#. /dbInfraBackupRestore.sh backup
This script will make a backup with the necessary tables for the Inventory node.
d) After the script has executed, check in the /tmp folder for the output file, which will have a name something like
infra_database_backup.tar.gz.
Although actual file names may vary. This is the given name for the purposes of this explanation.
Step 2
Continue the database backup with the Monitor node.
a) Login as root user.
b) cd /opt/infra
c) From infra, execute the dbMonitoringBackupRestore.sh as shown below.
#. / dbMonitoringBackupRestore.sh backup
This script will make a backup with the necessary tables for the Monitor node.
d) After the script has executed, check in the /tmp folder for the output file, which will have a name something like
monitoring_database_backup.tar.gz.
Troubleshooting Tips
This ends the database backup procedures. Next, you restore the database on each Inventory and Monitor node. This
involves copying each backed up file from the backup appliance to the appropriate node. After the files are placed on
the nodes, execute the script again. This time, however, you execute the script individually in each node (that is, in each
Inventory and Monitor node).
Step 3
Start the database restore process by stopping services.
a) Stop services on the Primary node.
b) Stop services on the Service node(s). If there are multiple Services nodes, stop services on all of them.
Step 4
Restore the database on each Inventory and Monitor node.
Cisco UCS Director Shell Guide, Release 5.3
54
Configuring a Multi-Node Setup
Migrating a Release 4.1 Standalone Appliance to a Multi-Node Setup with Selective Database Table Backup
a) Copy each backed up file from the backup appliance to the appropriate node.
b) After the files are placed on the nodes, execute the script again. But this time, execute the script individually in each
node (in each Inventory and Monitor node).
Step 5
Start the first database Restore process with the Inventory Node.
a) Login as root user.
b) Copy the backup file, infra_database_backup.tar.gz, from the backup appliance to the /tmp folder in the Inventory
node appliance.
c) In the Inventory node appliance, use cd /opt/infra
d) From infra, execute the dbInfraBackupRestore.sh script as shown below.
#. /dbInfraBackupRestore.sh restore
This script will restore the database from the backup file, infra_database_backup.tar.gz, placed in /tmp folder.
Step 6
Continue the database Restore process with the Monitor Node.
a) Login as root user.
b) Copy the backup file, monitoring_database_backup.tar.gz, from the backup appliance to the /tmp folder in the
Monitor node appliance.
c) In the Monitor node appliance, use cd /opt/infra
d) From infra, execute the dbMonitoringBackupRestore.sh script as shown below.
#. / dbMonitoringBackupRestore.sh restore
This script will restore the database from the backup file, monitoring_database_backup.tar.gz, placed in /tmp folder.
What to Do Next
Test thoroughly.
Cisco UCS Director Shell Guide, Release 5.3
55
Configuring a Multi-Node Setup
Migrating a Release 4.1 Standalone Appliance to a Multi-Node Setup with Selective Database Table Backup
Cisco UCS Director Shell Guide, Release 5.3
56