nxos_install_os - Set boot options like boot image and kickstart image.

New in version 2.2.


  • Install an operating system by setting the boot options like boot image and kickstart image.


parameter required default choices comments
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
Name of the kickstart image file on flash.
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
Name of the system (or combined) image file on flash.
(added in 2.3)
no 10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.


- block:
    - name: Install OS
        system_image_file: nxos.7.0.3.I2.2d.bin
    - name: Wait for device to perform checks
        port: 22
        state: stopped
        timeout: 300
        delay: 60
    - name: Wait for device to come back up
        port: 22
        state: started
        timeout: 300
        delay: 60
    - name: Check installed OS
          - show version
      register: output
    - assert:
          - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I4(1)'

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
Boot and install information.
always dictionary {'sys': 'n5000-uk9.7.2.1.N1.1.bin', 'status': 'This is the log of last installation.\nContinuing with installation process, please wait.\nThe login will be disabled until the installation is completed.\nPerforming supervisor state verification.\nSUCCESS\nSupervisor non-disruptive upgrade successful.\nInstall has been successful. ', 'kick': 'n5000-uk9-kickstart.7.2.1.N1.1.bin'}



  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • The module will fail due to timeout issues, but the install will go on anyway. Ansible’s block and rescue can be leveraged to handle this kind of failure and check actual module results. See EXAMPLE for more about this. The first task on the rescue block is needed to make sure the device has completed all checks and it started to reboot. The second task is needed to wait for the device to come back up. The last two tasks are used to verify the installation process was successful.
  • Do not include full file paths, just the name of the file(s) stored on the top level flash directory.
  • You must know if your platform supports taking a kickstart image as a parameter. If supplied but not supported, errors may occur.
  • This module attempts to install the software immediately, which may trigger a reboot.
  • In check mode, the module tells you if the current boot images are set to the desired images.


This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.