The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes how to use the Device OS Management feature in Cisco Data Center Network Manager (DCNM).
The Device OS Management feature allows you to control the operating system installed on Nexus 7000 Series devices that are managed by DCNM. You can create software installation jobs that affect one or more managed devices. DCNM can transfer the software images of operating systems to managed devices using one of several supported protocols. Installation jobs can also use software images already present on managed devices.
This chapter includes the following sections:
The Device OS Management feature allows you to control the software images installed on certain devices that are managed by Cisco DCNM.
This section includes the following topics:
The Device OS Management screen allows you to view information about the software images used by a managed device. You can also start the Software Installation wizard from the Device OS Management Summary pane.
The Software Installation Jobs feature allows you to create and monitor software installation jobs. Cisco DCNM provides the Software Installation wizard, which you use to specify all the necessary information for configuring a software installation job.
You can create software installation jobs that affect one or more managed devices. You can use software images that are already in the local file system of the devices or Cisco DCNM can instruct each managed device included in a job to transfer software images to the local file system on the managed device. Your options are as follows:
You can specify a software image for a device type category rather than for a single device; however, the image that you specify must exist on each device in the category in the same location and with the same filename. For example, if you specify bootflash:/images/n7000-s1-dk9.4.1.2.upg.bin, the n7000-s1-dk9.4.1.2.upg.bin image file must exist in bootflash:/images on each device in the device category.
Before configuring a software installation job, you should ensure that the software images are on the file server. You must also configure the file server in Cisco DCNM. For more information, see the “File Servers” section.
– FTP—Cisco DCNM verifies the URL format, that the FTP server in the URL is reachable, and that the specified image file exists on the FTP server. The FTP URL format is as follows:
ftp:// username @ servername / path / filename
– SFTP—Cisco DCNM verifies the URL format, that the SFTP server in the URL is reachable, and that the image file specified exists on the SFTP server. The SFTP URL format is as follows:
sftp:// username @ servername / path / filename
– TFTP—You must ensure that the path and image filename are correct. Cisco DCNM verifies the URL format and that the TFTP server in the URL is reachable. The TFTP URL format is as follows:
tftp:// servername / path / filename
– SCP—You must ensure that the SCP server is reachable and that the path and image filename are correct. Cisco DCNM verifies the URL format. The SCP URL format is as follows:
scp:// username @ servername / path / filename
The Software Installation wizard includes an optional step for verifying the version compatibility of software images with the managed devices. During this step, if a software image was specified by a URL or file server, Cisco DCNM instructs managed devices to copy the software image from the URL or file server to the bootflash file system on the device. If you skip the version compatibility step, Cisco DCNM does not instruct devices to copy software images from URLs or file servers until the installation job begins.
The File Servers feature allows you to configure file servers, which you can use for the following purposes:
Cisco DCNM supports file servers that use the following protocols:
If you use a file server in a software installation job, consider the following items:
Device software images apply to physical devices rather than virtual device contexts (VDCs). When you change the software image on a managed device, all VDCs on the device use the new software image.
The following table shows the licensing requirements for this feature:
The Device OS Management feature has the following prerequisites (for a full list of feature-specific prerequisites, see the platform-specific documentation):
The Device OS Management feature has the following configuration guidelines and limitations:
The following platforms support this feature but may implement it differently. For platform-specific information, including guidelines and limitations, system defaults, and configuration limits, see the corresponding documentation.
|
|
---|---|
The Device OS Management window allows you to view information about the software images used by a managed device. You can also start the Software Installation Wizard from the Device OS Management Summary pane.
This section includes the following topics:
You can view details about the software image on a managed device.
Step 1 From the Feature Selector pane, choose Device OS Management.
A table of managed devices appears in the Summary pane. Each row displays software image information about a device. Devices are listed alphabetically.
Step 2 Click the device for which you want to see software image details.
The Details pane displays two sections of information. In addition to displaying the information also shown in the Summary pane, if an installation job is scheduled, the System section displays a message about any scheduled installation job, including a link to the installation job.
The Software Installation Jobs section displays information about future, ongoing, and past installation jobs.
Tip To expand or collapse the System or the Software Installation Jobs sections, double-click the section title.
Step 3 (Optional) To open a scheduled software installation job, in the System section, click the link to the installation job.
The Feature Selector pane changes to the Software Installation Jobs feature. For more information, see the “Viewing Software Installation Job Details” section.
You can install software on a device listed on the Device OS Management Summary pane. Installing software from the Device OS Management Summary pane starts the Software Installation wizard, which allows you to create or modify a software installation job.
Ensure that the software images that you want to install are available by one of the options that the Software Installation wizard supports. For more information, see the “Software Installation Jobs” section. The supported options are the following:
You can specify a software image for a device type category rather than for a single device; however, the image that you specify must exist on each device in the category in the same location and with the same filename. For example, if you specify bootflash:/images/n7000-s1-dk9.4.1.2.upg.bin, the n7000-s1-dk9.4.1.2.upg.bin image file must exist in bootflash:/images on each device in the device category.
– FTP—DCNM verifies the URL format, that the FTP server in the URL is reachable, and that the specified image file exists on the FTP server. The FTP URL format is as follows:
ftp:// username @ servername / path / filename
– SFTP—DCNM verifies the URL format, that the SFTP server in the URL is reachable, and that the image file specified exists on the SFTP server. The SFTP URL format is as follows:
sftp:// username @ servername / path / filename
– TFTP—You must ensure that the path and image filename are correct. DCNM verifies the URL format and that the TFTP server in the URL is reachable. The TFTP URL format is as follows:
tftp:// servername / path / filename
– SCP—You must ensure that the SCP server is reachable and that the path and image filename are correct. DCNM verifies the URL format. The SCP URL format is as follows:
Step 1 From the Feature Selector pane, choose Device OS Management >Device OS Management.
A table of managed devices appears in the Summary pane.
Step 2 Click a device that you want to include in a new software installation job.
Step 3 From the menu bar, choose Actions > Install Software.
The Software Installation wizard dialog box displays the Select Switches step. The device that you selected is listed under Selected Switches.
Step 4 To use the wizard, see the “Using the Software Installation Wizard” section.
The Software Installation Jobs feature allows you to create and monitor software installation jobs.
This section includes the following topics:
You can view the details of a software installation job, including its status.
You must have configured a software installation job before you can view its details.
Step 1 From the Feature Selector pane, choose Device OS Management > Software Installation Jobs.
The Summary pane displays a table of software installation jobs.
Step 2 Click the software installation job for which you want to view details.
The Details pane displays two sections of information. The General section displays the job ID, the job owner, scheduling information, comments, and installation options.
The Device and Software Images section displays a table of devices included in the job, the software images to be installed on each device, and the status of the installation for the device.
Tip To expand or collapse the General or the Device and Software Images sections, double-click the section title.
From the Software Installation Jobs content pane, you can create a software installation job or edit an existing job. Creating or editing a job from the Software Installation Jobs content pane starts the Software Installation wizard, which allows you to create or modify a job.
Ensure that the software images that you want to install are available by one of the options that the Software Installation wizard supports. For more information, see the “Software Installation Jobs” section.The supported options are the following:
To ensure that software image files transfer as quickly as possible, use a file server that is on the same LAN as the devices included in the software installation job. If the available file servers transfer software image files too slowly, before you create the software installation job, manually copy the files to the devices that you will include in the job and configure the job to use the manually copied files rather than a file server.
You can specify a software image for a device type category rather than for a single device; however, the image that you specify must exist on each device in the category in the same location and with the same filename. For example, if you specify bootflash:/images/n7000-s1-dk9.4.1.2.upg.bin, the n7000-s1-dk9.4.1.2.upg.bin image file must exist in bootflash:/images on each device in the device category.
– FTP—DCNM verifies the URL format, that the FTP server in the URL is reachable, and that the specified image file exists on the FTP server. The FTP URL format is as follows:
ftp:// username @ servername / path / filename
– SFTP—DCNM verifies the URL format, that the SFTP server in the URL is reachable, and that the image file specified exists on the SFTP server. The SFTP URL format is as follows:
sftp:// username @ servername / path / filename
– TFTP—You must ensure that the path and image filename are correct. DCNM verifies the URL format and that the TFTP server in the URL is reachable. The TFTP URL format is as follows:
tftp:// servername / path / filename
– SCP—You must ensure that the SCP server is reachable and that the path and image filename are correct. DCNM verifies the URL format. The SCP URL format is as follows:
Step 1 From the Feature Selector pane, choose Device OS Management > Software Installation Jobs.
The Summary pane displays a table of software installation jobs.
Step 2 Do one of the following:
The Software Installation wizard dialog box displays the Select Switches step.
Step 3 To use the wizard, see the “Using the Software Installation Wizard” section.
You can use the Software Installation wizard to configure a new software installation job or make changes to an existing software installation job.
Start the Software Installation wizard, from one of the following places:
Step 1 In the Software Installation wizard dialog box, follow these steps for each device that you want to include in the installation job:
a. Under Available Switches, click the device.
Tip To remove a device from the job, under Selected Switches, click the device and then click Remove.
The Software Installation wizard dialog box displays the Specify Software Images step. Devices are categorized by the physical device type. You can specify software images for each device individually or for an entire category of devices of the same physical type.
Step 3 For each device or physical device category, specify a kickstart image and a system image. To do so, follow these steps once for the Kickstart Image field and again for the System Image field:
a. In the applicable image field, click to activate the field and then click the more button.
The Software Image Browser dialog box appears.
b. Specify the location of the file for the software image to be installed. To do so, choose one of the following options:
If you are specifying a software image for a device type category, the image specified must exist on each device in the category in the same location and with the same filename.
If you specified a URL, Cisco DCNM verifies the URL.
The Software Image Browser dialog box closes. The applicable image field displays the software image that you chose.
Step 4 (Optional) If you do not want the Software Installation wizard to verify that the selected kickstart and system software images are compatible with a device, check the Skip Version Compatibility check box in the row of the device.
Tip The Next button remains unavailable until you have specified a kickstart image and a system image for each device included in the software installation job.
If you specified a URL or a software image repository for the location of software images, Cisco DCNM instructs the devices in the job to retrieve the images from the specified locations.
If any device does not have enough space in its local file system to receive the software image files, a dialog box provides you the option to free up space on the device.
Step 6 If you receive a warning about insufficient space on the device, do one of the following:
Unless you chose to skip the version compatibility check for every device in the installation job, the Software Installation wizard dialog box displays the Pre-installation Checks step. The Version Compatibility Check column indicates whether a device passed or failed the check.
Step 7 If the Software Install wizard dialog box displays the Pre-installation Checks step, follow these steps:
a. If any device failed the version compatibility check, do one of the following:
– If you want to change the software image files specified for a device, click Back and return to Step 3.
– If you want the job to proceed by not installing software on devices that failed the version compatibility check, check the Skip devices with version compatibility failure check box.
The Software Installation wizard dialog box displays the Installation Options and Schedule step.
Step 8 (Optional) If you want the job to save the current configuration or delete the current configuration on each device, follow these steps:
a. Check the Installation Options check box.
b. If you want the job to copy the running configuration to the startup configuration on each device, click the Save Running Configuration to Startup before Installation radio button. After the installation job, devices in the job will have the same configuration that they did prior to the job, unless the installation is an upgrade or downgrade that modifies the running configuration.
c. If you want the job to delete the startup configuration on each device, click the Erase Startup Configuration before Installation radio button. After the installation job completes, devices in the job will have only the default running configuration.
Step 9 Under Schedule, do one of the following:
Step 10 (Optional) In the Comments field, enter a comment about the installation job.
Step 11 Under Execution Mode, do one of the following:
Step 12 (Optional) If you want the software installation job to save the log data for failed installations, check the Archive logs from switches on DCNM server upon installation failure check box.
If you specified a date and time for the job under Schedule, the wizard closes and the job appears in the Summary pane.
If you clicked the Install Now radio button under Schedule, the Software Installation Status dialog box displays information about each device in the job and the job status.
Step 14 If the Software Installation Status dialog box appears, do one of the following:
Tip If you abort software installation on all devices, click Close to close the dialog box.
You can change the scheduled date and time of a software installation job.
The software installation job that you want to reschedule must have a status of Scheduled. You cannot reschedule aborted or completed jobs.
Step 1 From the Feature Selector pane, choose Device OS Management > Software Installation Jobs.
The Summary pane displays a table of software installation jobs.
Step 2 In the Summary pane, click the job that you want to reschedule.
The Details pane displays information about the job.
Step 3 (Optional) From the Details tab, expand the General section, if necessary.
Step 4 Use the Scheduled At field to specify when the job should begin.
Step 5 From the menu bar, choose File > Deploy to save the change to the job schedule.
You can delete a software installation job, regardless of its state. In the Summary pane for Software Installation Jobs, completed and aborted jobs remain until you delete them.
Step 1 From the Feature Selector pane, choose Device OS Management > Software Installation Jobs.
The Summary pane displays a table of software installation jobs.
Step 2 In the Summary pane, click the job that you want to delete.
The Details pane displays information about the job.
Step 3 From the menu bar, choose Actions > Delete.
A Warning dialog box displays a confirmation message.
The job is removed from the summary pane. You do not need to save your changes.
You can add or change the comments associated with a software installation job.
Step 1 From the Feature Selector pane, choose Device OS Management > Software Installation Jobs.
The Summary pane displays a table of software installation jobs.
Step 2 In the Summary pane, click the job for which you want to add or change comments.
The Details pane displays information about the job.
Step 3 (Optional) From the Details tab, expand the General section, if necessary.
Step 4 In the Comments field, enter your comments.
Step 5 From the menu bar, choose File > Deploy to save the change to the job schedule.
You can change the installation options associated with a software installation job. Installation options allow you to specify whether Cisco DCNM should save the running configuration of devices, delete the startup configuration, or take no action on the configuration of devices prior to installing the software.
Step 1 From the Feature Selector pane, choose Device OS Management > Software Installation Jobs.
The Summary pane displays a table of software installation jobs.
Step 2 In the Summary pane, click the job for which you want to add or change comments.
The Details pane displays information about the job.
Step 3 (Optional) From the Details tab, expand the General section, if necessary.
Step 4 If you want devices in the software installation job to have only the default device configuration after the installation job completes, follow these steps:
a. Check the Installation Options check box.
b. If you want the job to delete the startup configuration on each device, click the Erase Startup Configuration before Installation radio button.
Step 5 If you want devices in the software installation job to have the same running configuration after the installation job completes, follow these steps:
a. Check the Installation Options check box.
b. If you want the job to copy the running configuration to the startup configuration on each device, click the Save Running Configuration to Startup before Installation radio button.
Step 6 If you want the devices in the software installation job to use their current startup configuration as their running configuration after the software installation job completes, uncheck the Installation Options check box.
Step 7 From the menu bar, choose File > Deploy to save the change to the job schedule.
The File Servers feature allows you to configure files servers, which you can use for the following purposes:
This section includes the following topics:
Gather the following information about the file server:
Note If you use the hostname, it must be registered with the DNS server that the Cisco DCNM server is configured to use.
Step 1 From the Feature Selector pane, choose Device OS Management > File Servers.
The Contents pane displays a table of file servers.
Step 2 From the menu bar, choose Actions > New File Server.
A new row appears in the Contents pane, with the cursor in the Server Name/IP Address field.
Step 3 In the Server Name/IP Address field, enter the IP address or hostname of the file server.
Step 4 Double-click the Protocol field and choose the protocol from the list that appears. Supported protocols are as follows:
Step 5 If the file server requires authentication, double-click the User Credentials field and enter the username and password for the server. If you want Cisco DCNM to remember the password, check the Save Password check box.
Step 6 Double-click the Base Directory field.
The Software Image Browser dialog box appears.
Step 7 Explore the server file system and choose the directory that Cisco DCNM should use as the base directory. All files and directories that Cisco DCNM needs to access must be located under this directory. By default, the root directory of the server is the base directory.
Step 8 (Optional) Double-click the Comment field and enter your comments.
Step 9 From the menu bar, choose File > Deploy to save the change to the job schedule.
You can change the user credentials, base directory, and comments of a file server.
Note You cannot change the values in the Server Name/IP Address or Protocol fields. If you need to change these values, delete the file server and create a file server with the new values.
If you are changing the user credentials or base directory, determine what the new user credentials or base directory should be.
Step 1 From the Feature Selector pane, choose Device OS Management > File Servers.
The Contents pane displays a table of file servers.
Step 2 In the table, locate the row for the file server that you want to change.
Step 3 Perform the following items to change the file server entry as needed:
Step 4 From the menu bar, choose File > Deploy to save the file server changes.
Ensure that the file server is specified in the Archival Settings feature as the file server for configuration rollback. For more information, see the “Configuring the Rollback File Server Setting” section.
Step 1 From the Feature Selector pane, choose Device OS Management > File Servers.
The Contents pane displays a table of file servers.
Step 2 In the table, click the row for the file server that you want to delete.
Step 3 From the menu bar, choose Actions > Delete.
Note If the file server is specified in the Archival Settings feature as the file server for a configuration rollback, a dialog box informs you that the file server cannot be deleted. For more information, see the “Configuring the Rollback File Server Setting” section.
The file server is removed from the summary pane. You do not need to save your changes.
This section includes field descriptions for the three features available in the Feature Selector drawer for Device OS Management:
This section includes the following field descriptions for the Device OS Management feature:
This section includes the following field descriptions for the Software Installation Jobs feature:
|
|
---|---|
Display only. Filename of the kickstart image currently installed on the managed device. |
|
Display only. Filename of the system image currently installed on the managed device. |
For additional information related to the Device OS Management feature, see the following sections:
|
|
---|---|
No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature. |
Table 10-6 lists the release history for this feature.
|
|
|
---|---|---|
Support was added for Cisco Nexus 4000 Series Switches and Cisco Nexus 5000 Series Switches. |