Table Of Contents
Managing Device and Credentials
Understanding DCR
DCR Architecture
Master DCR
Slave DCR
Standalone DCR
Using the Device and Credential Admin
Managing Devices
Adding Devices
Deleting Devices
Editing Device Credentials
Editing Device Identity
Importing Devices and Credentials
Exporting Devices and Credentials
Excluding Devices
Viewing Devices List
Managing Auto Update Servers
Adding Auto Update Server
Editing Auto Update Server
Deleting Auto Update Server
Generating Reports in DCA
Configuring Device Selector
Using Device Selector
Selecting Devices for Device Management Tasks
Selecting Devices From All Tab
Selecting Devices From Search Results
Combination of Selection From All Tab and Search Results
Searching Devices
Performing Simple Search
Performing Advanced Search
Device Selector Settings
Understanding Device Groups
Customizing Device Grouping
Customizing Display Order of Device Groups
Administering Device and Credential Repository
Changing DCR Mode
Master-Slave Configuration Prerequisites
Changing the Mode to Standalone
Changing the Mode to Master
Changing the Mode to Slave
Adding User-defined Fields
Renaming User-defined Fields
Deleting User-defined Fields
Using DCR Features Through CLI
Adding Devices Using dcrcli
Deleting Devices Using dcrcli
Editing Devices Using dcrcli
Listing the Attributes
Viewing the Current DCR Mode Using dcrcli
Viewing Device Details
Changing DCR Mode Using dcrcli
Import Using CLI
Export Using CLI
Implications of ACS Login Module on DCR
Custom Roles and DCR
Managing Device and Credentials
The Device and Credential Repository (DCR) is a common repository of devices, their attributes, and credentials, meant to be used by various network management applications. The Device and Credential Admin (DCA) provides an interface to administer DCR.
The following sections provide information on DCR features:
•
Understanding DCR
•
DCR Architecture
•
Using the Device and Credential Admin
•
Managing Auto Update Servers
•
Generating Reports in DCA
•
Configuring Device Selector
•
Administering Device and Credential Repository
•
Using DCR Features Through CLI
•
Implications of ACS Login Module on DCR
Understanding DCR
DCR helps multiple applications share device lists and credentials using a client-server mechanism, with secured storage and communications. The applications can read or retrieve the information. The applications can also update the information in DCR so that the updated information could be shared with other applications.
DCR provides:
•
A central place where you can add or import new devices.
•
Easier and faster access to device and credential data.
•
Secure data persistence, access and transport.
•
Rationalized and controlled replication, with less user-level data reconciliation.
•
Better integration with third-party and Cisco network-management applications.
DCR also:
•
Stores device attributes and credentials, permits dynamic creation of attribute types, and permits default grouping and filtering.
•
Supports proxy device attributes, unreachable devices, and pre-provisioning of devices.
•
Allows you to populate the repository by importing devices from many sources. It also allows you to export device data to be used with third-party network management systems such as NetView and HP OpenView Network Node Manager.
•
Uses a unique Internal Device Identifier to access device details, and detects duplicate devices based on specific attributes.
•
Encrypts credential data stored in the repository. Access to device data is permitted only by secured channel and client authentication.
•
Supports IPv6 and SNMP v3.
Credentials are values that are used by applications to access and operate on devices. It is typically an SNMP community string or a user ID and password pair. A device credential is used to access a managed device such as a switch or router.
Device attributes are unique to each device and they identify a device. The following attributes are stored in the repository:
Table 5-1 Attributes and Description
Attribute
|
Description
|
host_name
|
Device Host name.
|
domain_name
|
Domain name of the device.
|
management_ip_address
|
IP address used to access the device. Both IPv4 and IPv6 address types are supported.
|
device_identity
|
Identifies pre-provisioning devices. The value would be application specific.
|
display_name
|
Device name, as you want it to be represented in reports or graphical displays. Can be derived from Host Name, Management IP address or Device Identity.
|
sysObjectID
|
sysObjectID value. It may be UNKNOWN if the facility that populates the repository is not aware of the value.
|
mdf_type
|
Normative name for the device type as described in Cisco's Meta Data Framework (MDF) database. Each device type has a unique normative name defined in MDF.
|
DCR Device ID
|
Internally generated unique sequential number that identifies the device record in the DCR database.
The DCR clients should know the value to access device details from the repository.
|
User Defined Fields
|
DCA, by default, provides four user defined fields. These fields are used to store additional user-defined data for a device.
You can add more User Defined fields. A maximum of ten User Defined Fields are supported by DCR.
|
http_mode
|
Current transport mode.
|
http_port
|
The HTTP Port.
|
https_port
|
The HTTPS Port.
|
cert_common_name
|
Certificate Common Name.
|
The mandatory attributes are:
•
Management IP address or Host Name or Device Identity.
•
Display Name.
Individual applications interact with the repository to get the device list, device attributes, and device credentials.
For CNS managed devices, apart from the above two attributes, CNS Server also is mandatory. For DSBU member devices, DSBU member number and display name are sufficient. For AUS managed devices Display Name and Device-Identity are sufficient.
The Display Name and the Host Name/Domain Name combination must be unique for each device in DCR. A device will be considered duplicate if:
•
The Display Name of a device is the same as the Display Name of any other device.
•
The Host Name/Domain Name combination of a device is the same as that of any other device.
•
Auto Update Device ID is the same as Auto Update Device ID of any other device (when the device is AUS managed)
•
Cluster and Member Number, together is the same as that of any other device (when the device is Cluster managed)
The following credentials can be associated with a device in DCR:
Table 5-2 Credentials and Description
Credential
|
Description
|
Standard Credentials
|
primary_username
|
Primary user name used to access the device.
|
primary_password
|
Password for the primary_username.
|
primary_enable_password
|
Console-enabled password for the device. Allows you to make configuration changes and provides access to a larger set of commands.
Without the enable password, users are restricted to read-only operations.
|
snmp_v2_ro_comm_string
|
SNMP V2 read-only community string of the device.
|
snmp_v2_rw_comm_string
|
SNMP V2 read/write community string of the device.
|
snmp_v3_user_id
|
SNMP V3 user ID of the device.
|
snmp_v3_password
|
SNMP V3 password of the device.
|
snmp_v3_engine_ID
|
SNMP V3 engine ID of the device.
|
snmp_v3_auth_algorithm
|
SNMP V3 authorization algorithm used on the device. Can be MD5 or SHA-1.
|
http_username
|
Device's HTTP-interface user ID.
|
http_password
|
Device's HTTP-interface password.
|
rxboot_mode_username
|
Special case username (for example, RxBoot mode in 2500)
|
rxboot_mode_password
|
Password for the Rx Boot Mode user.
|
Additional Credentials for Cluster Managed Devices
|
dsbu_member_number
|
Number of the Cluster member. This number represents the order in which the device was added to the cluster.
|
parent_dsbu_id
|
DCR Device ID of the parent Cluster device.
|
Auto Update Server Specific Credentials
|
aus_url
|
URL for the AUS device.
|
aus_port
|
Port number of the AUS service running on the AUS device.
|
aus_username
|
User login providing access to the AUS device.
|
aus_password
|
Password for the corresponding aus_username.
|
Auto Update Server Managed Device -Specific Credentials
|
aus_username
|
User login providing access to the AUS-managed device.
|
aus_password
|
Password for the corresponding aus_username.
|
parent_aus_id
|
DCR Device ID of the managing AUS device.
|
CNS Managed Device Specific Credentials
|
parent_cns_id
|
Device ID of the parent CNS server (CNS Configuration Engine)
|
cns_config_id
|
CNS Config ID of the device.
|
cns_image_id
|
CNS Image ID of the device
|
cns_event_id
|
CNS Event ID of the device
|
DCR supports Cisco Cluster Management Suites, Auto Update Servers and the managed devices, CNS Configuration Engine and CNS Managed devices, using a mix of standard and additional attributes and credentials.
•
Clusters: All the attributes of the Cluster are the same as a normal DCR device.
•
Cluster Members: Each cluster member has its own Host Name, sysObjectID, and MDF type, and uses the same Telnet credentials as the Cluster. Each cluster member has the following additional attributes:
–
Member Number: The number of the Cluster member. This number represents the order in which the device is added into the cluster.
–
Device ID of the parent Cluster record.
•
Auto Update Server: The Auto Update Server has the following attributes and credentials:
–
URN
–
Username
–
Password
•
Auto Update Server managed devices: Apart from having its own attributes and credentials as normal DCR devices in DCR, each Auto Update Server managed device has the following additional attributes:
–
Device Identity: The string value that uniquely identifies this device in the parent Auto Update Server.
–
The DCR Device ID of the parent Auto Update Server record.
DCR Architecture
The sharing of device list and credentials among various network management products is achieved through a Client-Server mechanism. The clients are network management applications that use DCR. The server is called the DCR Server.
DCR works based on a Master-Slave model. DCR Server can also be in Standalone mode.
Master DCR
The Master DCR server refers to the master repository of device list and credential data. The Master hosts the authoritative, or a master-list of all devices and their credentials. All other DCRs in the same management domain which are running in Slave mode normally shares this list.
There is only one Master repository for each management domain, and it contains the most up-to-date device list and credentials.
DCR Master Server communicates with its Slaves through the HTTPS port. If there is a firewall in between the CiscoWorks Servers of the same DCR management domain, you must:
•
Open the HTTPS port of CiscoWorks Servers for communication.
•
Permit the ICMP requests and responses between the CiscoWorks Servers.
Only then the peer certificates can be exchanged and the communication could happen between the DCR Master and Slave servers.
Changes to the repository data in DCR Master are properly propagated to Slaves although you block or close the HTTPS port of DCR Slave Server in firewall. However the DCR status of Slave server is displayed as Unreachable in DCR Master.
But you should never block the HTTPS port of DCR Master Server in firewall. Otherwise communication between the servers in the same management domain will not happen.
Note
The default HTTPS port is 443. You can change the default HTTPS port number to some other port number. See Changing Web Server Port Numbers for details.
Slave DCR
The Slave DCR refers to a repository that is an exact replica of the Master.
DCR Slaves are slave instances of DCR in other servers and provide transparent access to applications installed in those servers.
Any change to the repository data occurs first in the Master, and those changes are propagated to multiple Slaves. There can be more than one Slave in a management domain.
The Slave:
•
Maintains an exact replica of the data managed by the Master for the management domain.
•
Has a mechanism to keep itself synchronized with the Master.
•
Will first update Master and then update its own repository data. This is in case of repository data updates.
Note
If the AAA mode is set to ACS, ensure that all the servers within the DCR Master-Slave domain are in ACS mode.
Standalone DCR
In Standalone mode, DCR maintains an independent repository of device list and credential data. It does not participate in a management domain and its data is not shared with any other DCR. It does not communicate with or contain registration information about any other Master, Slave, or Standalone DCR.
DCR running in Master or Slave mode always has an associated DCR Group ID that indicates the Server's management domain. This Group ID is generated when a DCR is set to Master mode, and communicated to all Slaves later assigned to that Master.
Using the Device and Credential Admin
Device and Credential Admin (DCA) helps you in:
•
Managing Devices
•
Generating Reports in DCA
•
Managing Auto Update Servers
•
Administering Device and Credential Repository
Managing Devices
The Device Management option in DCA helps you manage the list of devices and their credentials. Device Management helps you in:
•
Adding Devices
•
Deleting Devices
•
Editing Device Credentials
•
Editing Device Identity
•
Importing Devices and Credentials
•
Exporting Devices and Credentials
•
Excluding Devices
•
Viewing Devices List
You can use the improved Device Selector to search and select the devices for performing device management tasks. See Configuring Device Selector for more information.
Adding Devices
You can use this feature to add devices, device properties or attributes, and device credentials to the DCA.
To add devices to the device list:
Step 1
Go to the CiscoWorks Homepage, select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
The Device Management UI helps you perform operations on Standard Devices, Cluster Managed devices and Auto Update devices. Operations on Auto Update Servers can be performed only at the Auto Update Server Management UI.
The Device Summary window displays the devices and groups in DCA.
Step 2
Click Add.
The Device Properties page appears. The Device Information dialog box provides four device management types:
•
Standard Type
•
Auto Update Type
•
Cluster Managed Type
•
CNS Managed Type
Standard Type
You can add Routers, Switches, Hubs, and other devices using the Standard management type.
To add devices and credentials using Standard type:
Step 1
Select the Standard from the Select A Management Type drop-down list box.
Step 2
Enter the Device IP address, the host name, domain name, the device display name, and the device type in the corresponding fields.
To select the Domain Name and the DeviceType, click Select and choose from the list.
DCR uses a device record to represent a Cluster. A Cluster can be added in the Standard Management option by selecting the Device Type field as Cisco Cluster Management Suite.
DSBU Clusters added this way, can then be selected in Cluster Managed Type, for the field Cluster.
You can add a Cisco CNS Configuration Engine in the Standard Management option by selecting the Device Type field as Cisco CNS Configuration Engine. The Cisco CNS Configuration Engine added here can be selected in the CNS Server field in the CNS Managed option.
After a Cisco CNS Configuration Engine or DSBU Cluster is successfully added, it will appear under
Network Management > Other Network Management Products > Cisco CNS Configuration Engine/Cisco Cluster Management Suite, in the Device Selector.
Step 3
Click Add to List
The device is added to the Added Device List in the window.
To remove the device from the Device List, select the device and click Remove from List.
Step 4
Click Next.
The Standard Credentials page appears.
Step 5
Enter the credentials in the Add Credential Template. The following credentials can be added:
•
Primary Credentials (Username, Password, Enable Password)
•
SNMP v2C credentials (Read-Only Community String, Read-Write Community String)
•
SNMPv3 Credentials (Username, Password, authentication Algorithm, Engine ID)
•
Rx Boot Mode Credentials (Username, Password)
If you do not want to proceed, click Finish.
Step 6
Click Next.
The HTTP Settings page appears.
Step 7
Enter the following credentials in the HTTP Settings dialog box.
•
HTTP Username
•
HTTP Password. Re-enter the HTTP password in the Verify field.
•
HTTP Port
•
HTTPS Port
•
Certificate Common Name
Specify the current connection mode (HTTP or HTTPS) by selecting the appropriate radio button.
If you do not want to proceed, click Finish.
Step 8
Click Next.
The Standard UDF dialog box appears.
Step 9
Enter your choices for User Defined Fields and click Finish.
By default, DCA provides the option to define four attribute fields for a device. These fields are used to store additional user-defined data for the device.
The attribute fields that appear here can be changed in the User Defined Fields page. Click Device and Credentials > Admin > User Defined Fields from the Common Services application to open the User Defined Fields page.
Auto Update Type
You can use this feature to add, edit, and delete devices managed using Auto Update Server. The CiscoWorks Auto Update Server is a web-based interface for upgrading device configuration files and software images on firewalls that use the auto update feature.
The Auto Update Server managed device has its own attributes and credentials just like normal devices in DCR. In addition, it will have the following attributes:
•
Device Identity: The string value that uniquely identifies the device in parent Auto Update Server.
•
The DCR Device ID of the parent Auto Update Server record.
To add devices and credentials using Auto Update type:
Step 1
Select the Auto Update from the Select A Management Type drop-down list box.
Step 2
Enter the Device Type, Display Name, Auto Update Device ID, Host Name, Domain Name, and IP address in the corresponding fields.
To select Auto Update Server, Domain Name, and the Device Type click Select and select from the resulting popup windows. For Auto Update Server managed devices, Display Name and Device-Identity are enough for identity.
DCR uses a device record to represent an Auto Update Server. An Auto Update Server can be added in the Auto Update Server Management UI. Auto Update Server added this way can then be selected for the field Auto Update Server.
Step 3
Click Add to List.
The device gets added to the Added Device List in the window.
To remove the device from the Device List, select the device and click Remove from List.
Step 4
Click Next.
The Standard Credentials page appears.
Step 5
Enter the credentials in the Add Credential Template. The following credentials can be added:
•
Primary Credentials (Username, Password, Enable Password)
•
SNMP v2C credentials (Read-Only Community String, Read-Write Community String)
•
SNMPv3 Credentials (Username, Password, authentication Algorithm, Engine ID)
•
Rx Boot Mode Credentials (Username, Password)
If you do not want to proceed, click Finish.
Step 6
Click Next.
The HTTP Settings page appears.
Step 7
Enter the following credentials in the HTTP Settings dialog box.
•
HTTP Username
•
HTTP Password. Re-enter the HTTP password in the Verify field.
•
HTTP Port
•
HTTPS Port
•
Certificate Common Name
Specify the current connection mode (HTTP or HTTPS) by selecting the appropriate radio button.
If you do not want to proceed, click Finish.
Step 8
Click Next.
The Auto Update Server Credential Template dialog box appears.
Step 9
Enter the Auto Update Server managed device credentials (Username, Password) in the corresponding fields.
Note
These are the credentials to login to the Auto Update Server — not to access the managed device.
Step 10
Click Next.
The User Defined Fields dialog box appears.
Step 11
Enter your selections for User-defined fields and click Finish.
By default, you can define four attribute fields for a device. These fields are used to store additional user-defined data for a device.
The attribute fields that appear here can be changed at Device and Credentials > Admin> User Defined Fields.
Cluster Managed Type
DCR supports Cisco Clusters and their member devices using a mix of standard and additional attributes and credentials.
To add devices and credentials using Cluster Managed type:
Step 1
Select the Cluster Managed from the Select A Management Type drop down list box.
Step 2
Enter Device Type, Display Name, Device IP address, Device Host Name, Domain Name, Cluster, and Member Number in the corresponding fields. For member devices, member number and display name are enough for identity.
The Member Number field is mandatory. The Member Number is the number of the Cluster member. This number represents the order in which the device is added into the cluster.
Also, Cluster needs to be added before a Cluster Managed device.
For example, if a device X belongs to cluster Y, first add the Cluster Y, and then add the Cluster Managed device X.
Step 3
Click Add to List.
The device is added to the Added Device List in the window.
To remove a device from the Device List select the device and click Remove from List.
Step 4
Click Next.
The User Defined Field dialog box appears.
Step 5
Enter your selections for User-defined fields and click Finish.
By default, you can define four attribute fields for a device. These fields are used to store additional user-defined data for the device.
The attribute fields that appear here can be changed at Device and Credentials > Admin > User Defined Fields.
CNS Managed Type
To add devices and credentials using CNS Managed type:
Step 1
Select CNS Managed from the Select A Management Type drop-down list box.
Step 2
Enter the Device IP address, the hostname, and the domain name.
The display name you want for the device in reports or graphical displays in the corresponding fields.
You can also enter or select the domain name.
Step 3
Select the CNS Server and the device type by clicking Select and choosing from the list.
You can add a Cisco CNS Configuration Engine in the Standard Management option by selecting the Device Type field as Cisco CNS Configuration Engine.
If you add a Cisco CNS Configuration Engine in this way, you can select these engines in the CNS Managed option, for the CNS Server field.
After a Cisco CNS Configuration Engine is successfully added, it appears under
Network Management > Other Network Management Products > Cisco CNS Configuration Engine, in the Device Selector.
CNS Server and Display Name are mandatory.
Step 4
Click Add to List.
The device is added to the Added Device List in the page.
To remove a device from the Device List select the device and click Remove from List.
Step 5
Click Next.
The CNS Managed Device Credentials page appears.
Step 6
Enter the credentials in the Standard Credentials dialog box.
You can add the following credentials:
•
Primary Credentials (Username, Password, Enable Password).
•
SNMPv2c/SNMPv1 Credentials (Read-Only Community String, Read-Write Community String).
•
SNMPv3 Credentials (Username, Password, Authentication Algorithm, Engine ID).
•
Rx Boot Mode Credentials (Username, Password).
If you do not want to proceed, click Finish.
Step 7
Click Next.
The HTTP Settings page appears.
Step 8
Enter these credentials in the HTTP Settings dialog box.
•
HTTP Username.
•
HTTP Password. Re-enter the password in the verify field.
•
HTTP Port.
•
HTTPS Port.
•
Certificate Common Name.
Step 9
Specify the current connection mode (HTTP or HTTPS) by selecting the appropriate radio button.
Step 10
Click Next.
Step 11
Enter your choices for user-defined fields and click Finish.
By default, Device and Credential Repository allows you to define four attribute fields for a device. These fields store additional user-defined data for a device.
You can change the attribute fields at
Device and Credentials > Admin > User Defined Fields.
Deleting Devices
You can delete device information from DCR using this feature.
When a device is deleted, it will also get deleted in all the applications that use DCR.
To delete devices:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
Step 2
Select the device from the Device Summary dialog box and click Delete.
The device is removed from the device list. Also, all information about the selected device will be removed from DCR.
Editing Device Credentials
You can edit device information for a single device or for multiple devices using this feature.
To edit device information:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
Step 2
Select one or more devices from the Device Selector and click Edit Credentials.
The Standard Credentials dialog box appears.
Step 3
According to your requirement, you can edit:
•
Primary Credentials (Username, Password, Enable Password).
•
SNMPv2c/SNMPv1 credentials (Read-Only Community String, Read-Write Community String).
•
SNMPv3 credentials (Username, Password, Authentication Algorithm, Engine ID).
•
Rx Boot Mode Credential (Username, Password).
•
Auto Update Server Managed Device Credentias (Username, Password).
Note
Re-enter the values in the Verify fields.
Any changes made here will apply to all devices selected in Step 2. This has one exception.
If in Step 2, devices belonging to different device management types are selected, the changes made will apply only to devices of the appropriate type. That is, if a standard-device credential is changed, only the standard devices selected in Step 2 are affected.
If you have completed editing, and do not want to proceed, click Finish.
Step 4
Click Next if you want to edit HTTP Settings.
The HTTP Settings Page opens.
You can edit:
•
HTTP Username.
•
HTTP Password. Re-enter the password in the verify field.
•
HTTP Port.
•
HTTPS Port.
•
Certificate Common Name.
•
Current Mode (HTTP or HTTPs)
If you have completed editing, and do not want to proceed, click Finish.
Step 5
Click Next if you want to edit User Defined Fields.
The User Defined Fields window appears.You can edit these fields and click Finish after you complete editing.
Auto Update Servers cannot be edited here. Even if they are selected in Step 2, they will not be affected. See "Editing Auto Update Server" section for details on editing Auto Update Server information.
Management Type for a device is defined while you add the device to DCR. You cannot change the Management Type for the device through the edit flow. For example, you cannot change:
•
Cisco Cluster Management Suite to any other Management Type and vice versa
•
Cisco CNS Configuration Engine to any other Management Type and vice versa
Editing Device Identity
You can edit Device Identity information for a single device in DCR. The Display Name and the Host Name/Domain Name combination must be unique for each device in DCR. When you edit a device, it will be considered as a duplicate if any one of the following occur:
•
The Display Name of a device is the same as the Display Name of any other device
•
The Host Name/Domain Name combination of a device is the same as that of any other device
•
Auto Update Device ID is the same as Auto Update Device ID of any other device (when the device is AUS managed)
•
Cluster and Member Number are the same as that of any other device (when the device is Cluster managed)
To edit the Device Identity information:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
Step 2
Select one or more devices from the Device Selector pane to edit their idenity information.
Step 3
Click Edit Identity.
The Device Properties dialog box appears with the list of selected devices, and attributes of the first device in the list.
Step 4
Select a device from the device list to edit its identity information.
The current attributes are automatically populated in the device information fields.
Step 5
Edit the device information, on the right pane.
You can edit the following information:
•
Device Type
•
Display Name
•
Device Identity (Auto Update Device ID, Auto Update Server, CNS Server, Host Name, Domain Name and IP Address)
•
Cluster Information (Cluster, Member Number)
Note
You can edit only one device at a time.
Step 6
Select another device from the device list to edit the identity information.
Step 7
After you have entered the settings for all the desired devices, click Apply.
Importing Devices and Credentials
You can import device lists, device properties or attributes and device credentials to the DCR and populate DCR using this feature.You can:
•
Import Using DCA Interface
or
•
Import Using CLI
Import Using DCA Interface
To import devices using DCA Interface:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
Step 2
Click Bulk Import.
The Import Devices popup window appears. You can import from any of the following:
•
File
•
Local NMS (Network Management Station)
•
Remote NMS
The following need to be taken care of, before you import from File:
•
Each device must have atleast two mandatory attributes including the Display Name.
The mandatory attributes are: Display Name, and Management IP address or Host Name or Device Identity.
For DSBU member devices, DSBU member number and display name are enough for identity.
For AUS managed devices Display Name and Device-Identity are enough. For a CNS managed device, CNS Server is a mandatory attribute.
•
If you do not know the sysObjectID of the device, specify it as UNKNOWN. If you specify the sysObjectID, the corresponding mdf_type will be automatically updated by DCR.
•
Specify the correct dcr_device_type of the device. The possible values are:
–
0—Standard Device
–
1—DSBU Cluster
–
3—AUS
–
4—CNS Configuration Engine
•
In case of proxy devices (devices that are managed by DSBU cluster or AUS or CNS), make sure that the manager (parent) and managed (child) devices are linked properly. For the proxy managed devices, specify the correct Parent ID attribute field. The following are the parent attributes:
–
parent_dsbu_id for DSBU cluster members
–
parent_aus_id for AUS managed devices
–
parent_cns_id for CNS managed devices
•
If the import file type is xml, make sure that it conforms with the dtd available at NMSROOT/objects/dcrimpexp/conf/device.dtd.
Importing From a File
To import from a file:
Step 1
Enter the file name.
Or,
Browse the file system and select the file using the Browse tab.
Step 2
Select CSV or XML file formats, as required.
Only CSV2.0 and CSV3.0 file formats are supported.
Step 3
Select either Use data from Import source or Use data from DCR, to resolve conflicts during import.
•
If you select Use data from Import source, the credentials from the import source will be used, and credentials for the device in DCR will be modified.
•
If you select Use data from DCR, the device credentials in DCR will be used.
Step 4
Schedule the task. To do this:
a.
Select the RunType from the drop-down list.
You can schedule importing the devices immediately or schedule the import for a later time. The scheduling can be periodic (daily, weekly, or monthly) or for a single instance (once).
b.
Select the date from the date picker.
Step 5
Enter the Job description in the Job Info field.
Step 6
Click Import.
Importing From Local NMS
To import from Local NMS:
Step 1
Select the Network Management System type from the NMS type drop-down list.
HPOV6.x and Netview7.x are supported.
Step 2
Enter the install location in the Install Location field.
Note
If the NMS is HP OpenViewNetwork Node Manager, make sure that you give the install location of HP OpenViewNetwork Node Manager. For example, On Windows, C:\Program Files\HP OpenView\NNM.
Step 3
Select either Use data from Import source or Use data from DCR, to resolve conflicts during import.
Step 4
Schedule the task. To do this:
a.
Select the RunType from the drop-down list.
You can schedule importing the devices immediately or schedule the import for a later time. The scheduling can be periodic (daily, weekly, or monthly) or for a single instance (once).
b.
Select the date from the date picker.
Step 5
Enter the Job description in the Job Info field.
Step 6
Click Import.
Importing From Remote NMS
Before you import from the remote NMS, ensure that:
•
The server running 3rd party NMS (HPOV, NetView) application is reachable from the Cisco Works server.
•
The remote server running 3rd party NMS accepts rsh connections and has a local user who has permission to run executables like ovtopodump within the 3rd party NMS. This user should have permissions to log into the NMS Server without a password. Also, the .rhosts file should be modified to enable login without password.
If you are importing from a remote NMS on host 2 to host 1 (CiscoWorks server), you need to add the following entries in the .rhosts file of host2: host1.domain.com SYSTEM (on Windows); where SYSTEM is a built-in Local System account.
For example, if you are importing from a remote NMS on XYZ.cisco.com to ABC.cisco.com, you need to add ABC.cisco.com SYSTEM host1.domain.com casuser (on Solaris).
To import from a remote NMS:
Step 1
Select the Network Management System type from the NMS type drop-down list.
If you select ACS, enter:
•
ACS Server Name or IP address in the Host Name field.
•
ACS admin user name in the User Name field.
•
ACS admin user password in the Password field.
•
Port number (default is 2002) in the Port field.
Step 2
Select the Operating System type from the OS type drop-down list.
Note
Windows is not supported.
Step 3
Enter the Host name, User name, and Install location in the corresponding fields.
Note
If the NMS is HPOV, make sure that you give the install location of HP Openview NNM (Network Node Manager). For example, /opt/HP OpenView/NNM.
Step 4
Select either Use data from Import source or Use data from DCR, to resolve conflicts during import.
Step 5
Schedule the task. To do this:
a.
Select the RunType from the drop-down list.
You can schedule importing the devices immediately or schedule the import for a later time. The scheduling can be periodic (daily, weekly, or monthly) or for a single instance (once).
b.
Select the date from the date picker.
Step 6
Enter the Job description in the Job Information field.
Step 7
Click Import.
Import Status Report
The Import Status Report appears at the end of each immediate import operation. The report contains information on:
•
Newly Imported Devices
This field shows the number of devices that are newly imported during the bulk import operation.
•
Devices Not Imported.
This field shows the devices that are not imported.
The devices that have not been imported might fall under one of the following categories:
Devices
|
Description
|
Excluded Devices
|
Devices that are excluded based on the Exclude device list uploaded by the user. These devices will not be imported into DCR.
|
Duplicate Devices
|
Devices whose attribute are same as one of the devices in DCR. A device is considered duplicate if:
• The Display Name of a device is the same as that of any other device.
• The Host Name/Domain Name combination of a device is the same as that of any other device.
|
Conflicting Devices
|
Devices that are both in the import source and in DCR but differ in their attributes.
If you choose 'Use Data from Import Source' Conflict Resolution Option, you will see
Conflicting Devices (DCA CHANGED)
and the device in DCR will be updated with the attributes from the import source.
If you choose Use Data from Device and Credential Repository Conflict Resolution Option, you will see
Conflicting Devices (DCA NOT CHANGED)
and the device in DCR will not be updated with attribute from the import source.
|
Error Devices
|
If DCR encounters error during a device import, the device will be added to the Error Devices list.
Click the Error Devices link in the Import Status Report to see the Error Device List Report. Error Device List Report provides the reason for the failure. Import the device after rectifying the errors.
Management IP address, Host Name, Device Identity, and Display Name are mandatory attributes while importing.
For DSBU member devices, DSBU member number and display name are enough for identity.
For AUS managed devices Display Name and Device-Identity are enough.
|
Sample CSV File
You can use CSV 2.0 or CSV 3.0 file or XML formats for import.
You can also perform a DCR Export operation to generate sample CSV or XML files. See Exporting Devices and Credentials for more information.
You should not delete any line from the CSV file generated by DCR export utility including the lines starting with ; (semi colon). However, you can add comments in the CSV file as new lines beginning with ; character.
If you use manually created CSV files for DCR import, we recommend that the CSV files should be in the same format of the files generated by DCR Export utility.
Sample CSV 2.0 File
; This file is generated by the export utility
; If you edit this file, be sure you know what you are doing
Cisco Systems NM data import, source = export utility; Version = 2.0; Type = Csv
; Here are the columns of the table.
; Columns 1 and 2 are required.
; Columns 3 through 19 are optional.
; Col# = 1: Name (including domain or simply an IP)
; Col# = 2: RO community string
; Col# = 3: RW community string
; Col# = 4: Serial Number
; Col# = 9; Name = Telnet password
; Col# = 10; Name = Enable password
; Col# = 11; Name = Enable secret
; Col# = 12; Name = Tacacs user
; Col# = 13; Name = Tacacs password
; Col# = 14; Name = Tacacs enable user
; Col# = 15; Name = Tacacs enable password
; Col# = 16; Name = Local user
; Col# = 17; Name = Local password
; Col# = 18; Name = Rcp user
; Col# = 19; Name = Rcp password
; Here are the rows of data.
172.20.118.156,public,,FHH080600dg,,,,,,,,,,,,,,,
172.20.118.150,public,,FHH0743W022,,,,,,,,,,,,,,,
Sample CSV 3.0 File
; This file is generated by DCR Export utility
Cisco Systems NM Data import, Source=DCR Export; Type=DCRCSV; Version=3.0
;Start of section 0 - Basic Credentials
;HEADER:
management_ip_address,host_name,domain_name,device_identity,display_name,sysObjectID,dcr_d
evice_type,mdf_type,snmp_v2_ro_comm_string,snmp_v2_rw_comm_string,user_defined_field_0,use
r_defined_field_1
10.77.202.40,Switch6009,cisco.com,,Switch2,1.3.6.1.4.1.9.1.281,0,268438100,public,private,
field0,field1
10.77.202.10,Router7000,cisco.com,,Router1,1.3.6.1.4.1.9.1.8,0,278464493,public,private,fi
eld0,field1
10.77.202.30,Switch4006,cisco.com,,Switch1,1.3.6.1.4.1.9.5.46,0,268438086,public,private,f
ield0,field1
10.77.202.20,Router6400,cisco.com,,Router2,1.3.6.1.4.1.9.1.180,0,269214543,public,private,
field0,field1
Note
For a complete list of attributes and their description, use the lsattr command in dcrcli. See "Listing the Attributes" section for usage details.
Sample CSV 3.0 File for Auto Update Server Managed Devices
; This file is generated by DCR Export utility
Cisco Systems NM Data import, Source=DCR Export; Type=DCRCSV; Version=3.0
;Start of section 0 - Basic Credentials
;HEADER: management_ip_address,host_name,domain_name,device_identity,display_name,
sysObjectID,dcr_device_type,mdf_type,snmp_v2_ro_comm_string,snmp_v2_rw_comm_string,
snmp_v3_user_id,snmp_v3_password,snmp_v3_engine_id,
snmp_v3_auth_algorithm,primary_username,primary_password,primary_enable_password
1.1.1.1,ons_host1,cisco.com,AUS_ID,ONS1,1.3.6.1.4.1.9.1.406,0,273612892,,,,,,,,,
10.10.10.1,aus_server,cisco.com,,AUS_SERV1,UNKNOWN,3,UNKNOWN,,,,,,,,,
;Start of section 1 - AUS proxy
;HEADER:
management_ip_address,host_name,domain_name,device_identity,display_name,aus_username,aus_
password,aus_url
1.1.1.1,ons_host1,cisco.com,AUS_ID,ONS1,admin,admin,
10.10.10.1,aus_server,cisco.com,,AUS_SERV1,admin,admin,autoupdate/AutoUpdateServlet
;Start of section 2 - AUS managed
;HEADER:
management_ip_address,host_name,domain_name,device_identity,display_name,parent_aus_id
1.1.1.1,ons_host1,cisco.com,AUS_ID,ONS1,display_name=AUS_SERV1
Sample CSV 3.0 File for Cluster Managed Devices
; This file is generated by DCR Export utility
Cisco Systems NM Data import, Source=DCR Export; Type=DCRCSV; Version=3.0
;Start of section 0 - Basic Credentials
;HEADER: management_ip_address,host_name,domain_name,device_identity,display_name,
sysObjectID,dcr_device_type,mdf_type,snmp_v2_ro_comm_string,snmp_v2_rw_comm_string,
snmp_v3_user_id,snmp_v3_password,snmp_v3_engine_id,snmp_v3_auth_algorithm,primary_username
,
primary_password,primary_enable_password
1.1.1.1,ons_dev_1,cisco.com,,ONS1,1.3.6.1.4.1.9.1.406,0,273612892,,,,,,,,,
10.10.10.1,host1,cisco.com,,cluster1,Unknown,1,278283831,,,,,,,,,
;Start of section 3 - DSBU managed
;HEADER: management_ip_address,host_name,domain_name,device_identity,display_name,
dsbu_member_number,parent_dsbu_id
1.1.1.1,ons_dev_1,cisco.com,,ONS1,1,display_name=cluster
Mapping CSV 2.0 to CSV 3.0 Fields
The following table provides a mapping between the fields in CSV 2.0 and CSV 3.0:
CSV 2.0
|
CSV 3.0
|
Name (including domain or simply an IP)
|
host_name and display_name
|
RO community string
|
snmp_v2_ro_comm_string
|
RW community string
|
snmp_v2_rw_comm_string
|
Serial Number
|
Not used in CSV 3.0
|
User Field 1
|
user_defined_field_0
|
User Field 2
|
user_defined_field_1
|
User Field 3
|
user_defined_field_2
|
User Field 4
|
user_defined_field_3
|
Telnet password
|
primary_password
|
Enable password
|
primary_enable_password
|
Enable secret
|
primary_enable_password
|
Tacacs user
|
primary_username
|
Tacacs password
|
primary_password
|
Tacacs enable user
|
Not used in CSV 3.0
|
Tacacs enable password
|
primary_enable_password
|
Local user
|
primary_username
|
Local password
|
primary_password
|
Rcp user
|
Not used in CSV 3.0
|
Rcp password
|
Not used in CSV 3.0
|
Telnet password, Tacacs password, and Local password are matched to primary_password.
The Enable password, Enable secret, and Tacacs enable password are matched to primary_enable_password.
The Tacacs user and Local user are matched to primary_username.
The order of preference used to set these values in CSV 3.0:
•
If Tacacs username, password, enable password are set, then these values will be set as primary_username, primary_password and primary_enable_password.
•
If Local username and password are set, then the values will be set as primary_username and primary_password.
•
If Telnet password, Enable Password, and Enable Secret are set, then the values will be set as primary_password, and primary_enable_password (for both Enable Password, and Enable Secret).
Sample XML File
The sample XML files for importing devices is provided in this section.
Sample XML File (Standard)
<SET Name="Basic Credentials">
<DEVATTRIB Name="management_ip_address">10.77.202.40</DEVATTRIB>
<DEVATTRIB Name="host_name">Switch6009</DEVATTRIB>
<DEVATTRIB Name="domain_name">cisco.com</DEVATTRIB>
<DEVATTRIB Name="display_name">Switch2</DEVATTRIB>
<DEVATTRIB Name="sysObjectID">1.3.6.1.4.1.9.1.281</DEVATTRIB>
<DEVATTRIB Name="dcr_device_type">0</DEVATTRIB>
<DEVATTRIB Name="mdf_type">268438100</DEVATTRIB>
<DEVATTRIB Name="snmp_v2_ro_comm_string">public</DEVATTRIB>
<DEVATTRIB Name="snmp_v2_rw_comm_string">private</DEVATTRIB>
<DEVATTRIB Name="primary_username">lab</DEVATTRIB>
<DEVATTRIB Name="primary_password">lab</DEVATTRIB>
<DEVATTRIB Name="primary_enable_password">lab</DEVATTRIB>
Note
For a complete list of attributes and their description, use the lsattr command in dcrcli. See "Listing the Attributes" section for usage details. Also, see Attributes and Description and Credentials and Description.
Sample XML File for Auto Update Server Managed Devices
<SET Name="Basic Credentials">
<DEVATTRIB Name="management_ip_address">1.1.1.1</DEVATTRIB>
<DEVATTRIB Name="host_name">ons_host1</DEVATTRIB>
<DEVATTRIB Name="domain_name">cisco.com</DEVATTRIB>
<DEVATTRIB Name="device_identity">AUS_ID</DEVATTRIB>
<DEVATTRIB Name="display_name">ONS1</DEVATTRIB>
<DEVATTRIB Name="sysObjectID">1.3.6.1.4.1.9.1.406</DEVATTRIB>
<DEVATTRIB Name="dcr_device_type">0</DEVATTRIB>
<DEVATTRIB Name="mdf_type">273612892</DEVATTRIB>
<DEVATTRIB Name="aus_username">admin</DEVATTRIB>
<DEVATTRIB Name="aus_password">admin</DEVATTRIB>
<DEVATTRIB Name="device_identity">AUS_ID</DEVATTRIB>
<DEVATTRIB Name="parent_aus_id">display_name=AUS_SERV1</DEVATTRIB>
<SET Name="Basic Credentials">
<DEVATTRIB Name="management_ip_address">10.10.10.1</DEVATTRIB>
<DEVATTRIB Name="host_name">aus_server</DEVATTRIB>
<DEVATTRIB Name="domain_name">cisco.com</DEVATTRIB>
<DEVATTRIB Name="display_name">AUS_SERV1</DEVATTRIB>
<DEVATTRIB Name="sysObjectID">UNKNOWN</DEVATTRIB>
<DEVATTRIB Name="dcr_device_type">3</DEVATTRIB>
<DEVATTRIB Name="mdf_type">UNKNOWN</DEVATTRIB>
<DEVATTRIB Name="aus_username">admin</DEVATTRIB>
<DEVATTRIB Name="aus_password">admin</DEVATTRIB>
<DEVATTRIB Name="aus_url">autoupdate/AutoUpdateServlet</DEVATTRIB>
Sample XML File for Cluster Managed Devices
<SET Name="Basic Credentials">
<DEVATTRIB Name="management_ip_address">1.1.1.1</DEVATTRIB>
<DEVATTRIB Name="host_name">ons_dev_1</DEVATTRIB>
<DEVATTRIB Name="domain_name">cisco.com</DEVATTRIB>
<DEVATTRIB Name="display_name">ONS1</DEVATTRIB>
<DEVATTRIB Name="sysObjectID">1.3.6.1.4.1.9.1.406</DEVATTRIB>
<DEVATTRIB Name="dcr_device_type">0</DEVATTRIB>
<DEVATTRIB Name="mdf_type">273612892</DEVATTRIB>
<SET Name="DSBU managed">
<DEVATTRIB Name="dsbu_member_number">1</DEVATTRIB>
<DEVATTRIB Name="parent_dsbu_id">display_name=cluster1</DEVATTRIB>
<SET Name="Basic Credentials">
<DEVATTRIB Name="management_ip_address">10.10.10.1</DEVATTRIB>
<DEVATTRIB Name="host_name">host1</DEVATTRIB>
<DEVATTRIB Name="domain_name">cisco.com</DEVATTRIB>
<DEVATTRIB Name="display_name">cluster1</DEVATTRIB>
<DEVATTRIB Name="sysObjectID">Unknown</DEVATTRIB>
<DEVATTRIB Name="dcr_device_type">1</DEVATTRIB>
<DEVATTRIB Name="mdf_type">278283831</DEVATTRIB>
Exporting Devices and Credentials
You can use this feature to export a list of device and their credentials into a file. The device list can be obtained from the Device Selector, or from a CSV file.
You can edit the Export Format file located at NMSROOT\objects\dcrimpexp\conf\Export_Format_CSV.xml or Export_Format_XML.xml to specify the credentials you need to export.
However, User-defined Fields (UDFs) are not exported by default. If you want to export the User-defined Fields , you need to add the UDF names in the Export Format.
Note
You can export files in CSV (only CSV 3.0) and XML formats.
See "Sample CSV File" section and "Sample XML File" section for sample CSV and XML files.
To see the list of attributes that can be exported:
Step 1
Enter NMSROOT/bin/dcrcli -u username at the command prompt
Step 2
Enter the password corresponding to the user name.
Step 3
Enter lsattr
The list of attributes and their description is displayed. You can include the attributes you need to export, in the Export Format file.
You can:
•
Export Using DCA Interface
or
•
Export Using CLI
Export Using DCA Interface
To export device credentials using DCA Interface:
Step 1
In the CiscoWorks Homepage, select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
Step 2
Click Export.
The Device Export dialog box appears.
You can use either of the following device selection methods:
•
Select from Device Selector
Select this option if you want to export devices from DCR to the file you specify in the Output File Information field. You can select the required devices from the Device Selector pane of the Device Export dialog box.
•
Get Device List from File
Select this option if you want to export devices from a CSV file that is already present in the server, to the file you specify in the Output File Information field.
You can use this option when the CSV file contains only partial device credentials, and you want to get the full list of credentials. The input CSV file checks for data in DCR, and exports the data to the output file.
If you choose to select from the Device Selector:
a.
Enter the location for the output file using the Output File Information panel.
b.
Select either CSV or XML as your output file format.
If you choose to get the device list from a file:
a.
From the Input File Selection Panel, click Browse to browse the file system and select the input file [in CSV format] to get the device list.
b.
Enter the location for the output file using the Output File Information panel.
c.
Select either CSV or XML as your output file format. From the Device Selector, select the devices for which you need to export credentials.
Step 3
Schedule the task. To do this:
a.
Select the RunType from the drop-down list.
You can schedule export immediately or schedule the export for a later time. The scheduling can be periodic (daily, weekly, or monthly) or for a single instance (only).
b.
Select the date from the date picker.
Step 4
Enter the Job description in the Job Info field.
Step 5
Click OK.
You must populate DCR with devices before you export credentials from DCR using Get Device List from File option.
Note
We recommend that you use this option to export upto a maximum of 1000 devices.
Excluding Devices
This feature allows you to specify a file that contains the list of devices that should not be added to DCR using Add or Import operations.
During the Add or Import operations, DCR ensures that the device being added or imported is not listed in the Exclude Device List.
You can also remove the list of devices that are excluded earlier using the Exclude operation.
The file containing the list of excluded devices should be in CSV format. See A Sample CSV Exclude File for a sample CSV file used for Exclude operation.
You can exclude devices by specifying any one or more of the following fields in the CSV file:
•
management_ip_address
•
host_name and domain_name
•
device_identity
If you are using a CSV file generated by the DCR Export utility to exclude devices from Add or Import operations, make sure to remove the sections related to AUS Managed, Cluster Managed and CNS Managed devices from the CSV file.
To exclude devices from Add or Import operations:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
Step 2
Click Exclude.
The Upload Exclude Devices File dialog box appears.
Step 3
Enter the file name or click Browse to browse the file system and select the file.
The file that needs to be uploaded must be in CSV format.
Step 4
Click Apply to upload the file.
A Sample CSV Exclude File
; This file is generated by DCR Export utility
Cisco Systems NM Data import, Source=DCR Export; Type=DCRCSV; Version=3.0
;Start of section 0 - Basic Credentials
;HEADER: management_ip_address,host_name,domain_name,device_identity
Viewing Devices List
You can view the devices in the Device List Report using this feature.
To view devices in the Device List Report:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Device Management.
The Device Management page appears.
Step 2
Select the devices you want from the Device Summary list and click View.
The Device List Report dialog box appears.
Step 3
Select the device.
Step 4
Click View.
Managing Auto Update Servers
Auto Update Servers have the following credentials:
•
Auto Update Server URL
•
Username
•
Password
Auto Update Server management feature helps you in:
•
Adding Auto Update Server
•
Editing Auto Update Server
•
Deleting Auto Update Server
Adding Auto Update Server
To add Auto Update Server:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Auto Update Server Management.
The Auto Update Server Management page appears.
Step 2
Click Add.
The Auto Update Server dialog box appears.
Step 3
Enter the Display Name, Domain Name, IP address, Host, Port, URN, User name, and password in the corresponding fields. Re-enter the password in the Verify field.
DCR uses a device record to represent a Auto Update Server.
An Auto Update Server added in the Auto Update Server Management UI can be selected for the field Auto Update Server when you add devices using the Auto Update management type.
Step 4
Click OK.
Editing Auto Update Server
To edit Auto Update Server:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Auto Update Server Management.
The Auto Update Server Management page appears.
Step 2
Select the device you want to edit from the list and click Edit.
The Auto Update Server dialog box appears.
Step 3
Edit Display Name, Domain Name, IP address, Port, URN, User name, and Password fields.
Step 4
Click OK.
Deleting Auto Update Server
To delete Auto Update Servers:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Auto Update Server Management.
The Auto Update Server Management page appears.
Step 2
Select the device you want to delete from the list.
Step 3
Click Delete.
Generating Reports in DCA
You can use this feature to generate and view Device and Credential Admin reports.
To generate reports:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Reports.
The Report Generator page appears.
Step 2
Select a report from the DCA Reports tree on the left panel to view a short description, summary, or parameters of the report.
You can select any of the following reports:
•
DCA Device List Report—Displays the complete device list in DCA.
•
DCA Audit Report—Displays the complete device list in DCA within a specified period of time.
•
Excluded Devices Report—Displays the excluded devices list.
•
Import Status Report—Displays the last imported device list.
•
DCA devices that are not configured in ACS report—Displays the list of DCA devices that need to be configured in ACS. The list shown by this report might not be accurate in the following cases:
–
If the ACS Admin Name/ ACS Admin Password given in the AAA setup page is not correct.
–
If there is an HTTP protocol mismatch between the ACS configuration in the CiscoWorks server and the actual ACS settings.
In this case, you must correct any ACS configuration mismatch.
Step 3
Select the report link in the Available Report pane and click Generate Reports to view the selected report.
You can export the report, or print the report.
To export the report:
Step 1
Click the Export Current Report button on top of the right hand side of the DCA Report list.
Step 2
Select the required radio button to export the report either in pdf or in CSV format.
Step 3
Enter the number of rows to be exported and click OK.
Configuring Device Selector
The improved Device Selector allows you to search the devices in DCR. It helps to locate the devices and perform the various device management tasks quickly. With this improved Device Selector, you need not remember the device type or application group hierarchy to locate the devices.
You can define the settings of the Device selector pane to customize the display of devices and the order of display.
This section contains the following information:
•
Using Device Selector
•
Selecting Devices for Device Management Tasks
•
Searching Devices
•
Device Selector Settings
Using Device Selector
The Device Selector is used to select devices to perform various device management tasks. This lists all devices in a group. The Display Name of the devices entered when you have added the devices in DCR is dispayed as the device name in the Device Selector pane.
Note
If you have configured your CiscoWorks Server in AAA mode, the devices will be listed based on your role and associated privileges that are defined in Cisco Secure ACS.
The Device Selector contains the following components:
Component Name
|
Description
|
Search Input
|
Enter your search expression in this text field.
You can enter a single device name or multiple device names in this field. You can enter the following as search inputs for searching multiple devices:
• Comma separated list of full device names
• Device names with wildcard characters * and ? to search for multiple devices matching the text string entered in this input field.
• Combination of comma separated list of device names, and device names with wildcard characters.
See Performing Simple Search for more information.
|
Search
|
Use this icon to perform a Simple search of devices, after you have entered your search input. See Performing Simple Search for more information.
|
Advanced Search
|
Use this icon to perform an Advanced search of devices. See Performing Advanced Search for more information.
|
All
|
This tab lists all the top-level device groups and the device names under each group in a hierarchical format (tree view).
The top-level device groups include:
• All Devices
• Device Type Groups
• Subnet Groups
• User Defined Groups
• Application Specific Groups (such as Campus Specific and RME Specific)
See Understanding Device Groups for more information on types of device groups.
|
Search Results
|
This tab displays all your Simple or Advanced search results and you can do a select all, clear all, or select a few devices from the list.
The Simple search results are based on the display name of the devices added to DCR. The Advanced search results are based on the grouping attributes of the application's grouping services server.
|
Selection
|
This tab lists all the devices that you have selected in the All or Search Results tab or through a combination of both. You can also use this tab to deselect the devices you have already selected.
You can perform more than one search and can accumulate your selection of devices.
|
The Device Selector displays the number of devices selected by you at the bottom. When you click the link provided, it launches the Selection Tab.
Tool tips are also provided for devices that contain long names so that you do not have to scroll horizontally to see the complete device name.
Selecting Devices for Device Management Tasks
You can select devices to perform various device management tasks such as editing device credentials and viewing device credentials, using any of these methods:
•
Selecting Devices From All Tab
•
Selecting Devices From Search Results
•
Combination of Selection From All Tab and Search Results
Selecting Devices From All Tab
You can select devices using the Tree View accessed by the All tab. The Selection tab shows the flat list of selected devices from the All tab.
Selecting Devices From Search Results
You can perform a Simple Search or Advanced Search, and the search results are displayed under the Search Results tab. You can select the devices you want from the Search Results tab. The Selection tab and the All tab display the devices you have selected from the Search Results tab.
Note
You can perform more than one search and can accumulate your selection of devices.
Combination of Selection From All Tab and Search Results
You can select the devices from the All tab and add more devices to the Selection list from the Simple or Advanced search results in the Search Results tab. You can select the required devices from the Search Results tab.
The Selection tab displays the accumulated list from both All and Search Results tabs. You can enter another search criteria and select more devices. The selected devices are accumulated in the All tab from the Selection tab and vice versa.
Searching Devices
With the improved Device Selector, you can search the devices by performing a Simple search or an Advanced search. In both cases, you do not need to remember the name of the devices and the groups in which the devices are grouped.
Note
The search string is not case sensitive in Common Services.
Performing Simple Search
You can enter your search criteria in the Search Input field and search for the devices using the Search icon. The search results are based on the display name of the devices added in DCR.63
Note the following points when you perform a Simple search.
•
You can enter a comma separated list of device names to search for multiple devices.
•
You can use the wildcard characters * and ? to search for multiple devices that match the text string entered in this input field. Multiple wild card characters are allowed in a search string.
•
You can use the combination of comma separated list of device names and wildcard characters in the device names to search for multiple devices.
•
If you are not using the wild card characters, make sure that you enter the full device name.
For example, when you enter device2?, *.cisco1 ,*device10* as search input, the system displays:
•
Device names starting with device2 and with only one character after device2
•
Device names ending with .cisco1
•
Device names containing the text string device10
Performing Advanced Search
Use the Advanced Search icon to open the Advanced Search popup window and specify a set of rules for performing an Advanced search. The advanced search is based on the grouping attributes of the application's grouping server. For example, when you launch an Advanced Search from Campus Manager Device Selector, the attributes of the Campus Manager Grouping server appears.
You can create a rule in the Advanced Search dialog box by either:
•
Using Expressions
or
•
Using Rule Text Fields
You can verify whether the rule you have entered is correct using the Check Syntax button, and reset the rule you have created using the Clear button
Using Expressions
You can use expressions to form a rule in the Advanced Search Dialog box. Each rule expression contains:
•
Device Type — Denotes the object type used for forming a group. All expressions start with the string Device
Variables — Denotes the device attributes, which are used to form a device group. The list of variables for advanced search are Category, DeviceIdentity, DisplayName, DomainName, HostName, ManagementIpAddress, MDFId, Model, Series, SystemObjectID, and the user defined fields, if any. See Attributes and Description for more information on variables.
The device attributes listed in Variables list box are specific to Common Services only. The list of device attributes are different across CiscoWorks applications. The Advanced Search window in the Device Selector of CiscoWorks applications displays the respective evice attributes as variables
•
Operators — Denotes the various operators to be used with the rule. The list of operators includes equals, contains, startswith and endswith. The list of operators changes dynamically with the value of the operator selected.
•
Value — Denotes the value of the variable. The value field changes dynamically with the value of the variable and operator selected, and this may be a text field or a list box.
After you define the rule settings, click Add Expression to add the rule expression . You can also enter multiple rule expressions using the logical operators. The logical operators include OR, EXCLUDE and AND.
For example, if you want to search all the devices in the network whose display name contains TestDevice or their SysObjectIDs start with 1.3.12.1.4, you must perform the following:
Step 1
Click the Advanced Search icon in the Device Selector pane.
The Define Advanced Search Rule dialog box appears.
Step 2
Create a expression by entering:
a.
Select Variable as DisplayName
b.
Select Operator as equals
c.
Enter the Value as TestDevice
Step 3
Click Add Rule Expression.
The rule is added into the Rule Text.
Step 4
Create another rule expression by entering:
a.
Select OR as the logical operator
b.
Select Variable as SystemObjectID
c.
Select Operator as startswith
d.
Enter the Value as 1.3.12.1.4
Step 5
Click Add Rule Expression.
The rule is appended into the Rule Text.
Step 6
Click Search to display the devices that satisfies the specified rule in the Device Selection dialog box.
Using Rule Text Fields
You can use Rule Text Fields to directly enter a rule without building any expressions. Ensure the rule you create follows the syntax Object type.Variable Operator Value.
You can also enter multiple rule expressions using the logical operators.
For example, if you want to search all the devices in the network whose display name contains TestDevice or their SysObjectIDs start with 1.3.12.1.4, you must construct a rule as follows:
Device.DisplayName contains "TestDevice" OR Device.SystemObjectID startswith 1.3.12.1.4"
Note the following when you perform a advanced search:
•
You cannot use wild card characters in the value field. Instead you can use the operator as startswith or contains.
•
You can use Check Syntax button, when you add or modify a rule manually
•
You must delete the complete rule including the logical operator, when you delete a portion of your rule.
•
The search string is case-insensitive.
Note
We recommend that you use expressions to construct a complex rule instead of creating them using the Rule Text field. Use the Rule Text field to make any minor edits to the constructed rule.
Device Selector Settings
The devices are categorized under the Device Type groups, User Defined groups, Subnet groups, Application specific groups or under All groups.
You can define the settings of the Device Selector pane to customize the display of devices and the order of display. These configurations are specific to each user and you can save them.
The devices are displayed in the appropriate category based on your roles and privileges. All the devices will be listed to the administrator role.
This section has the following information:
•
Understanding Device Groups
•
Customizing Device Grouping
•
Customizing Display Order of Device Groups
Understanding Device Groups
The Device Selector pane displays the following top-level device groups:
•
All Devices
•
Device Type Groups
•
Subnet Groups
•
User Defined Groups
•
Application Specific Groups
All Devices
The All Devices Group displays all the devices in the application in the alpahabetical order of their display names. The display names are defined when you have added the devices in DCR.
Device Type Groups
The Device Type Groups displays all devices in groups and subgroups based on their Device Category, Series and Model. By default, the device grouping is based on their Device Categories such as Routers, Switches and Hubs.
The Device Category Groups folder can contain devices in subgroups based on their Device Series. For example, the Device Category Group Router can contain devices (Routers) in subgroups Cisco 7000 Router Series and Cisco 12000 Router Series.
The Device Series subgroup can contain subgroups of devices based on thier Model. For example, the subgroup Cisco 12000 Router Series can contain the devices Cisco 12012 Router and Cisco 12816 Router .
See Customization of Device Type Groups for information on customizing the display of devices under Device Type Groups.
Subnet Groups
You can see Subnet Groups, only when Campus Manager is installed. It contains device groups from the Campus Manager application.
In a Multi Server setup, when two or more servers are installed with the Campus Manager application, then the Subnet Groups from all the servers will be aggregated and displayed under the Subnet Groups folder in the Device Selector pane.
See Customization of Subnet Groups for information on customizing the display of devices under this group.
User Defined Groups
The User Defined Groups are created by users to administer the applications. The User Defined Groups are created in Groups Administration window based on defined group rules.
All User Defined Groups (shared groups) from all application group hierarchies are collated and shown as subgroups under this group. In a Multi Server Setup, the top level User Defined Groups will be named as User Defined Groups@Server Name.
When there are more than one User Defined Group with the same name, the Device Selector displays all of them. You have to use the Tooltip to find the source server where the User Defined Group is created.
We recommend you to provide unique and meaningful names to User Defined Groups when you create them to avoid the display of multiple User Defined Groups with the same name.
See Customization of User Defined Groups for information on customizing the display of devices under this group.
Application Specific Groups
The Application Specific Groups list the groups based on device types or states specific to CiscoWorks applications. These application specific groups are not needed in other applications.
By default, the Application Specific Groups are displayed in the Device Selector pane of respective applications.
For example, RME Device Selector displays RME as the top level (application) group and sub device groups specific to device states in RME such as Normal Devices and Pre-deployed Devices.
In a Multi Server setup, the top level Application Specific Groups will be displayed as Application@Server Name.
For example, the Campus Manager and RME Application Groups will be displayed as Campus@Host1, Campus@Host2 in the Campus Manager Device Selector pane.
You can customize the Device Selector to display all the Application Groups from the local server or all peer servers in the Device Selector pane of all CiscoWorks applications, in a Multi-Server setup. The Application Specific Groups are displayed in the Device Selector pane of all applications, only when the particular application is installed.
For example, in a server setup with two servers Host1 and Host2, the Device Selector pane of all applications displays Campus@Host1, Campus@Host2, RME@Host1, RME@Host2, DFM@Host1 and DFM@Host2 groups.
Note
DFM Application Groups are not shared with any applications and will not be displayed in Device Selector of Common Services or any applications like RME and Campus. DFM Application Groups will be displayed only in the Device Selector of DFM application.
See Customization of Application Specific Groups for information on customizing the display of devices under this group.
Customizing Device Grouping
You can customize the device grouping and display the customized device groups in the Device Selector pane. See Understanding Device Groups for more information on Device Groups.
You can use the Group Customization option to customize the display of device groups.
This section contains the following sub sections:
•
Customization of Device Type Groups
•
Customization of Subnet Groups
•
Customization of User Defined Groups
•
Customization of Application Specific Groups
Customization of Device Type Groups
You can display or hide the Device Type Groups folder in the Device Selector pane using the Group Customization option. You can customize the Device Type Based Groups folder to display:
•
All devices in groups, based on their Device Category only
•
All devices in groups and subgroups, based on their Device Category and Series
•
All devices in groups and subgroups, based on their Device Category, Series and Model
By default, the Device Type Group folder displays the devices in sub groups based on their category only.
To display the devices in groups based on their Device Category:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Check the Show Category Groups check box from the Device Type Based Groups panel.
Step 3
Click Apply to save your changes or click Restore Defaults to restore the default values.
To display the devices in groups and subgroups based on their Device Category and Series:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Check the Show Series Groups check box from the Device Types Based Groups panel.
When you check the Show Series Groups check box, the Show Category Groups checkbox will also be checked automatically and will be disabled to you.
Step 3
Click Apply to save your changes or click Restore Defaults to restore the default values.
To display the devices in groups and subgroups based on their Device Category, Series and Model:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Check the Show Model Groups check box from the Device Type Based Groups panel.
When you check the Show Model Groups check box, the Show Category Groups and Show Series Groups checkboxes will also be checked automatically and will be disabled to you.
Step 3
Click Apply to save your changes or click Restore Defaults to restore the default values.
To hide the display of Device Type Based Folders from the Device Selector Pane:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Go to the Device Type Based Groups Panel and uncheck all the checkboxes.
Step 3
Click Apply to save your changes.
Customization of Subnet Groups
The Subnet Groups contains device groups from the Campus Manager application. By default, the Subnet Based Groups folder is not displayed in the Device Selector pane.
You can customize the Device Selector pane to display the Subnet Based Groups folder using the Group Customization option.
To display the devices under Subnet Based groups in the Device Selector Pane:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Check the Show Subnet Groups at the First Level check box from the Subnet Based Groups Panel.
Step 3
Click Apply to save your changes or click Restore Defaults to restore the default values.
Customization of User Defined Groups
You can customize the User Defined Groups folder in the Device Selector pane to contain the following:
•
Only User Defined Groups created by you in the local server
•
Only User Defined Groups created by you in all Peer Servers in a Multi Server setup
•
All User Defined Groups created by any user in the local server
•
All User Defined Groups created by any user in all Peer Servers in a Multi Server setup
By default, you can view all the User Defined Groups (irrespective of any user) created in the local server in the Device Selector pane.
To display only the User Defined Groups created by you:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Select My User Defined Groups from the Show drop down list box in the User Defined Groups panel.
Step 3
Select either:
•
Local CiscoWorks Server from the From drop down list to display the User Defined Groups created by you in the local server.
Or
•
All Peer CiscoWorks Servers from the From drop down list box to display the User Defined Groups created by you in all the servers in a Multi-server setup.
In a Standalone Server Setup, the From drop down list box contains only Local CiscoWorks Server list item.
Step 4
Click Apply to save your preferences.
To display all the User Defined Groups created by all users:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Select All User Defined Groups from the Show drop down list box in the in the User Defined Groups panel.
Step 3
Select either:
•
Local CiscoWorks Server from the From drop down list to display the User Defined Groups in the local server.
Or
•
All Peer CiscoWorks Servers from the From drop down list box to display the User Defined Groups in all the servers in a Multi-server setup.
In a Standalone Server Setup, the From drop down list box contains only Local CiscoWorks Server list item.
Step 4
Click Apply to save your preferences.
Customization of Application Specific Groups
The Application Specific Groups folder in the Device Selector Pane contains the device groups specific to the application.
You can customize the Application Specific Groups folder in the Device Selector pane to contain the following:
•
Only the application specific groups in the local server — For example, you can see only the RME Groups created in the local server, in RME Workflows and DFM Groups created in the local server in DFM Workflows.
•
Only the application specific groups in all Peer Servers in a Multi-Server setup — You can see the RME Groups created in all Peer Servers, in RME Workflows.
For example, you can see RME@Master, RME@Slave1, and RME@Slave2 as the top level groups in the Device Selector pane.
•
All the application groups created in the local server — You can see the Application Groups created in the local server, as the top level groups in the Device Selector pane.
For example, you can see Campus, DFM and RME if the applications are installed on a CiscoWorks Server.
•
All the application groups created in all Peer Servers in a Multi-Server setup — You can see the Application Groups created in all Peer Servers as the top level groups in the Device Selector pane.
For example, you can see RME@Master, Campus@Master, RME@Slave1, Campus@Slave1, RME@Slave2, and DFM@Slave2 as the top level groups in the Device Selector pane irrespective of the application workflow.
By default, you can view the application groups created in the local server only in the Device Selector pane of the respective applications.
To display only local application groups in the Device Selector Pane:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Select This Application Groups from the Show drop down list box in the Application Specific Groups panel.
Step 3
Select either:
•
Local CiscoWorks Server from the From drop down list to display the Application Specific Groups in the local server.
or
•
All Peer CiscoWorks Servers from the From drop down list box to display the Application Specific Groups in all the servers in a Multi-server setup.
In a Standalone Server Setup, the From drop down list box contains only This Local Server list item.
Step 4
Click Apply to save your preferences.
To display all the Application Groups in the Device Selector Pane:
Step 1
Go to the CiscoWorks homepage and select Device and Credentials > Device Selector Settings > Group Customization from the Common Services application.
The Group Customization page appears.
Step 2
Select All Application Groups from the Show drop down list box in the Application Specific Groups Panel.
Step 3
Select either:
•
This Local CiscoWorks Server from the From drop down list to display the Application Specific Groups in the local server.
or
•
All Peer CiscoWorks Server from the From drop down list box to display the Application Specific Groups in all the servers in a Multi-server setup.
In a Standalone Server Setup, the From drop down list box contains only This Local Server list item.
Step 4
Click Apply to save your preferences.
Customizing Display Order of Device Groups
You can specify the order in which device groups appear in the Tree view on the Device Selector pane using the Group Ordering option.
The Group Ordering setup is specific to each user and the changes will be reflected in the Device Selector panes of all applications.
The default order of the groups displayed in the Device Selector pane is:
1.
All Devices
2.
Device Type Groups
3.
User Defined Groups
4.
Subnet Groups
5.
Application Specific Groups
You can change the order and save the configurations.
To change the order of the device groups:
Step 1
Go to the Common Services application and select Device and Credentials > Device Selector Settings > Group Ordering to open the Group Ordering page.
Step 2
Select a group from the list displayed.
Step 3
Click Up to move the device group up in the displayed order or click Down to move down.
Step 4
Click Apply to save the changes to your system or click Restore Defaults to restore the default settings.
Administering Device and Credential Repository
The DCA Admin feature allows you to do the following tasks:
•
Changing DCR Mode
•
Adding User-defined Fields
•
Renaming User-defined Fields
•
Deleting User-defined Fields
To perform these tasks, select CiscoWorks Homepage > Device and Credentials > Admin. The Admin page appears with the current DCA settings.
You can change the Mode Settings or modify User Defined fields.
Changing DCR Mode
To change Mode Settings:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Admin.
The Admin page appears with the current DCA settings.
Step 2
Click the Mode Settings link.
The Mode Settings window appears.
Step 3
Click Change Mode to change the current mode.
The DCR Mode dialog box appears. You can select the required mode from this dialog box.
•
Changing the Mode to Standalone
•
Changing the Mode to Master
•
Changing the Mode to Slave
Master-Slave Configuration Prerequisites
Before you set up the Master and Slave, you have to perform certain tasks to ensure that secure communication takes place between the Master and Slave.
Note
You must ensure that the Master and all its Slaves in the management domain are running the same version of Common Services software.
If machine M is to be the Master and S is to be the Slave:
Step 1
Add a Peer Server User and password in M
See "Setting up Peer Server Account" section on page 4-14 for details.
Step 2
Add a System Identity user and password in S. This should be same as the Peer Server User set up in M.
See "Setting up System Identity Account" section on page 4-15, for details.
Step 3
Copy the Self-Signed Certificate of S to M. Also, copy the Self-Signed Certificate of M to S.
See "Creating Self Signed Certificates" section on page 4-7, for details on creating Self-Signed Certificate.
See "Setting up Peer Server Certificate" section on page 4-16, for details on copying Peer Certificate.
Step 4
Configure S as Slave and M as Master.
Changing the Mode to Standalone
Step 1
Select the Standalone radio button.
Step 2
Click Apply to change mode.
The default DCR mode is Standalone.
Changing the Mode to Master
Before you change the mode to Slave, ensure that Master-Slave Configuration Prerequisites are in place.
Step 1
Select the Master radio button.
Step 2
Click Apply to change mode.
Changing the Mode to Slave
Before you change the mode to Slave, ensure that Master-Slave Configuration Prerequisites are in place.
You need to perform the following tasks:
Step 1
Select the Slave radio button.
Step 2
Enter the hostname of the Master in the Master field.
This hostname should exactly match the Hostname field in the Master's Self Signed Certificate.
Step 3
Specify the SSL port of the master. Default is 443.
If the mode is changed from Master to Slave, select the Inform Current slave(s) of new Master Hostname check box.
If you select this check box, all the slaves of the Master (whose mode you currently changed to Slave) will be informed of the new master hostname. That is, they will become the slaves of the new Master.
If the Add new devices to Master check box is selected, the devices in Slave will be added to the new Master. However, any duplicate will be discarded.
Step 4
Click Apply.
Changing the Hostname of a Master
Changing the hostname of a Master is equivalent to pointing Slaves to a new Master.
When you point a Slave/Standalone to a new Master, DCR checks whether the new Master has the same Domain ID as the current machine.
If Domain ID is the same, DCR displays an error message that Master cannot be configured since the new Master has the same Domain ID.
In this case, you need to convert the Slave to Standalone, and then register the machine with the new Master. When you re- register, the applications on Slave will clean up the device list.
When you change the host name of the current Master, you must change the Slave's mode to Standalone, and then re-register the machine as a Slave by providing the new Master hostname. However, when the machine is re-configured as Slave, the applications will clean up the device list.
For exmaple, if you have a Master M and Slave S, and if you change the hostname of M, you should change the mode of S to standalone. Then, you have to configure S as the Slave of M. But when you re-configure S as Slave, the applications on S will clean up their device lists.
Therefore, you have to be aware of the fact that while changing the hostname of a Master, an application data is cleaned up on all Slaves.
Adding User-defined Fields
To add a user defined field:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Admin.
The Admin page appears with the current settings.
Step 2
Click the User-defined Fields link.
The User-defined Fields page appears.
Step 3
Click Add to add a User-defined field.
Step 4
Enter the field label and description in the corresponding fields.
Step 5
Click Apply to add the User-defined Field.
Renaming User-defined Fields
To rename a user-defined field:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Admin.
The Admin page appears with the current DCA settings.
Step 2
Click User-defined Fields link.
The User-defined Field dialog box appears
Step 3
Select the radio button corresponding to the User-defined Field you want to rename.
Step 4
Click Rename.
The User-defined Field dialog box appears.
Step 5
Enter the field label and description in the corresponding fields.
Step 6
Click Apply.
Deleting User-defined Fields
By default, you can define four attribute fields for a device. These fields are used to store additional user-defined data for the device. You can add up to Ten user defined fields.
To delete a user-defined field:
Step 1
Go to the CiscoWorks Homepage and select Common Services > Device and Credentials > Admin.
The Admin page appears with the current DCA settings.
Step 2
Click the User-defined Fields link in the TOC.
The User-defined Fields dialog box appears.
Step 3
Select a User-defined Field, then click Delete.
Using DCR Features Through CLI
Using Command Line Interface, you can add, delete, and modify devices, and change the DCR modes. You can also view the list of attributes that can be stored in DCR, and view the current DCR mode. The dcrcli provided with Common Services helps you perform these tasks using CLI.
The Display Name and the Host Name/Domain Name combination must be unique for each device in DCR. A device will be considered duplicate if:
•
The Display Name of a device is the same as that of any other device
•
The Host Name/Domain Name combination of a device is the same as that of any other device
•
Auto Update Device ID is the same as that of any other device (in case of AUS managed device)
•
Cluster and Member Number, together is same as that of any other device (in case of Cluster managed device)
dcrcli operates in both the Shell and Batch modes.
You can set DCRCLIFILE environment to point to the file where Common Services password is present.
If you set DCRCLIFILE variable, password will not be asked when you run dcrcli in shell or batch mode.
The password file should contain an entry in the format username password. Make sure that there is only one blank space between the username and the password in the password file.
For example, if admin is the username and the password for the CiscoWorks user, the password file must contain the following entry
admin admin
Adding Devices Using dcrcli
To add devices using dcrcli in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username. If you have set DCRCLIFILE environment, you will not be prompted for the password.
Step 3
Enter add ip=value hn=value di=value dn=value -a attname=value
Step 4
Enter either the IP address (ip), Hostname (hn), or Device Identity (di).
Step 5
Enter the Display Name (dn) and the Attribute name (-a attname). The attribute sysObjectID is mandatory. You can add multiple attributes. For example,
add ip=1.1.1.1 hn=device1 dn=cisco.com -a sysObjectID=1.3.6.1.4.1.9.1.6
To add devices using dcrcli in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=add ip=value hn=value di=value dn=value -a sysObjectID=value attname=value
Example: dcrcli -u admin cmd=add ip=1.1.1.1 hn=device1 dn=router1 -a sysObjectID=1.3.6.1.4.1.9.1.6
Deleting Devices Using dcrcli
To delete device using dcrcli in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username.
Step 3
Enter del id=value.
id is the Device ID. For example,
To delete device using dcrcli in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=del id=value
For example: dcrcli -u admin cmd=del id=54340
Editing Devices Using dcrcli
To modify devices using dcrcli in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password.
Step 3
Enter mod id=value ip=value hn=value di=value dn=value -a attname=value
Step 4
Enter the Device ID (id).
Step 5
Enter either the IP Address (ip), Hostname (hn), or Device Identity (di).
Step 6
Enter the Display Name (dn) and the Attribute name (-a attname). You can add multiple attributes. For example,
mod id=54341 ip=2.2.2.2 dn=cisco.com -a display_name=new_name
To modify devices using dcrcli in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=mod id=value hn=value di=value dn=value -a attname=value
For example, to change IP address and display name, enter:
dcrcli -u admin cmd=mod id=77 ip=4.4.4.4 dn=new_display_name
Listing the Attributes
To view the list of all attributes in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username
Step 3
Enter lsattr
This lists Attribute Name, Attribute Description, and Attribute Type.
Attribute Type is a constant that identifies an Attribute Name. For example, Attribute Type 1072 identifies the attribute name display_name.
To view the list of all attributes in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=lsattr
Viewing the Current DCR Mode Using dcrcli
To view the current DCR mode in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username
Step 3
Enter lsmode
It lists the DCR ID, the DCR Group ID, the current DCR mode, and the associated Master/Slaves.
To view the current DCR mode in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=lsmode
Viewing Device Details
To view device details using dcrcli in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username.
Step 3
Enter details id=DeviceID
This lists all the details about the device with the ID you have specified. For example,
detail id=54341 lists the details for the device with device ID 54341.
To view device details using dcrcli in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=detail id=DeviceID
Changing DCR Mode Using dcrcli
To change mode to Master in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username
Step 3
Enter setmaster
The DCR mode gets changed to Master.
To change mode to Master in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=setmaster
To change mode to Standalone in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username
Step 3
Enter setstand
The DCR mode gets changed to Standalone.
To change mode to Standalone in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=setstand
To change mode to Slave in Shell mode:
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the username
Step 3
Enter setslave master=value
You have to specify the Master for this slave.
The DCR mode gets changed to Slave. For example,
setslave master=1.2.1.3 port=443
To change mode to Slave in Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=setslave master=value
Import Using CLI
You can import using the Command Line Interface (Shell Mode).
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the user name.
•
To import from file:
Enter impFile fn=file name ft=file type cr=conflict resolution option
fn—the file name
ft—the file type; CSV and XML are the valid values.
cr—conflict resolution option. dcr and file are the valid values. This option is not mandatory. If value is not specified, dcr is taken as default.
Example:
impFile fn=/opt/CSCOpx/test.csv ft=csv
•
To import from Local NMS:
Enter impNms nt=NMS type il=Installation location cr=conflict resolution option
nt—NMS type. Valid values are HPOV6.x and Netview7.x
il—Installation location of the NMS
Example:
impNms nt=HPOV6.x il=/opt/OV
•
To import from Remote NMS:
Enter impRNms nt=NMS type hn=hostname un=Remote User Name il=Installation location ot=OS Type cr=conflict resolution option
nt — NMS type. Valid values are HPOV6.x and Netview7.x
hn — Remote Host Name or IP address
un — Remote User Name
il — Installation location of the NMS
ot — OS Type; Valid values are HPUX, AIX, or SOL
cr — Conflict resolution option. dcr and file are the valid values. This option is not mandatory. If value is not specified, dcr is taken as default.
The .rhosts file should be modified to allow this user to login to NMS Server without any password.
Example:
impRNms nt=HPOV6.x hn=1.2.3.4 un=root il=/opt/OV ot=SOL
•
To import from ACS:
In ACS mode, a device with valid IP address only will be imported to DCR. If a device has IP address of the form 10.10.1.*, in ACS, then it will not be imported.
Enter impACS ot=OS Type hn=ACS Server Name or IP address un=ACS admin user name pwd=ACS admin password prt=port number cr=conflict resolution option
ot— Operating System Type
hn — ACS Server Name or IP address
un — ACS admin user name
pwd— ACS admin password
prt — port number. Default is 2002.
cr—conflict resolution option. dcr and file are the valid values. This option is not mandatory. If value is not specified, dcr is taken as default.
Example:
impAcs ot=WIN2K hn=1.2.3.4 un=acsadmin pwd=acspwd prt=2002
The option cr is used to prioritize the selection and resolve conflicts during import. If dcr is specified as conflict resolution option, credentials for the device, stored in DCR will be used.
This is taken as default if cr is not specified. If import source (file or Nms or RNms or ACS) is specified as conflict resolution option, credentials from the import source will be used, and credentials in DCR will be modified.
You can also import using the Command Line Interface (Batch Mode):
To import from file:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=impFile fn=file name ft=file type cr=conflict resolution option
Toimport from Local NMS:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=impNms nt=NMS type il=Installation location cr=conflict resolution
To import from Remote NMS:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=impRNms nt=NMS type hn=hostname un=Remote Username cr=conflict resolution
To import from ACS:
Step 1
Go toNMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=impAcs ot=OS Type hn=ACS Server Name or IP address un=ACS admin username pwd=ACS admin password prt=port number cr=conflict resolution
Export Using CLI
You have the option to export using Command Line Interface.
Step 1
Enter NMSROOT/bin/dcrcli -u username.
Step 2
Enter the password corresponding to the user name.
Step 3
Enter exp fn=filename ft=filetype.
For filetype, CSV or XML are valid values. You can edit the Export Format file lExport_Format_CSV.xml or Export_Format_XML.xml to specify the credentials.
For example,
exp fn=/opt/CSCOpx/test.csv ft=csv
To export using Batch mode:
Step 1
Go to NMSROOT/bin
Step 2
Enter dcrcli -u Username cmd=exp fn=filename ft=filetype
Note
For a complete list of attributes and their description, use the lsattr command in dcrcli. See Listing the Attributes for usage details. Also, see Attributes and Description and Credentials and Description.
Implications of ACS Login Module on DCR
When Common Services is in ACS mode, you can perform operations in Device and Credential Repository (DCR) based on role assignment in ACS.
See Setting the Login Module to ACS for details on ACS login module.
Note
A device in DCR is mapped to a device in ACS based on IP address of that device in DCR and ACS. If a device in DCR has no IP address, then it's display_name in DCR is mapped to host-names available in ACS.
In DCR, you can see the buttons enabled or disabled, based on the role assigned to you.
For example, if a user U1 is assigned Approver role in ACS, the user can see only the View button enabled in DCR. A user can see only those devices in DCR 's device-selector for which you have View Devices task assigned in ACS.
When performing operations in DCR, although you select some devices, the operation will not be performed on all selected devices (unlike in CiscoWorks local mode). This is because the operation will be done only on those devices for which the you have the required privileges.
For example, a user U2 is assigned a Helpdesk role for device D1 and System Administrator role for device D2 in ACS. Now U2 is able to select both D1 and D2 in DCR. But when the user clicks on Delete, only device D2 will be deleted.
This is because U2 has a Helpdesk role for D1. The Helpdesk role does not allow users to perform the Delete task.
You can add a device to DCR even if you are not authorized to view or access a device. However, after adding, if the device is not in ACS or if you are not authorized to view the device, you will not be able to see the device in Device Management page.
In ACS mode, the Reports generated by DCR will not have the details of the devices that are not configured in ACS.
DCA devices that are not configured in ACS report—Displays the list of DCA devices that need to be configured in ACS. The list shown by this report might not be accurate in the following cases:
•
If the ACS Admin Name/ ACS Admin Password given in the AAA setup page is not correct. If there is an HTTP protocol mismatch between the ACS configuration in the CiscoWorks server and the actual ACS settings.
In this case, you must correct any ACS configuration mismatch.
Note
If the AAA mode is set to ACS, ensure that all the servers within the DCR Master-Slave domain are in ACS mode.
Custom Roles and DCR
You can create new roles in ACS and assign a new combination of tasks to that role. In ACS, if a Custom role is created, a few points should be considered for DCR related tasks because certain DCR tasks have interdependencies. If certain tasks are included in the custom role, there will be other tasks which must also be assigned to the role to help you carry out the operations successfully.
The following table gives the details.
Task
|
Dependent Tasks
|
View Devices
|
View Devices task. Necessary to see a device in DCR device-selector. This needs to be assigned for all tasks which require device selection.
|
Add
|
View Devices task is necessary for seeing AUS or Cisco Cluster in Add wizard.
|
Edit
|
View Devices task is necessary to see a device's details in Edit wizard.
|
Bulk import
|
Add and Update tasks are necessary.
|
Export
|
View Devices task is necessary.
|
Delete
|
None.
|
Reports
|
None.
|
Change Mode
|
None.
|
Add User Defined Fields in DCR
|
None.
|
Modify User Defined Fields in DCR
|
None.
|
Delete User Defined Fields from DCR
|
None.
|
Register/Unregister 3rd Party Application in DCR
|
None.
|