W3cubDocs

/Ansible

sros_rollback - Configure Nokia SR OS rollback

New in version 2.2.

Synopsis

Configure the rollback feature on remote Nokia devices running the SR OS operating system. this module provides a stateful implementation for managing the configuration of the rollback feature

Options

parameter required default choices comments
host
 yes
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.
local_max_checkpoints
 no
The local_max_checkpoints argument configures the maximum number of rollback files that can be saved on the devices local compact flash. Valid values for this argument are in the range of 1 to 50
password
 no
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
 no 22
Specifies the port to use when building the connection to the remote device.
provider
 no
Convenience argument that allows connection arguments to be passed as a dict object. These include host, port, username, password, ssh_keyfile, and timeout. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
remote_max_checkpoints
 no
The remote_max_checkpoints argument configures the maximum number of rollback files that can be transfered and saved to a remote location. Valid values for this argument are in the range of 1 to 50
rescue_location
 no
The rescue_location specifies the location of the rescue file. This argument supports any valid local or remote URL as specified in SR OS
rollback_location
 no
The rollback_location specifies the location and filename of the rollback checkpoint files. This argument supports any valid local or remote URL as specified in SR OS
ssh_keyfile
 no
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
state
 no present
  • present
  • absent
The state argument specifies the state of the configuration entries in the devices active configuration. When the state value is set to true the configuration is present in the devices active configuration. When the state value is set to false the configuration values are removed from the devices active configuration.
timeout
 no 10
Specifies idle timeout for the connection, in seconds. Useful if the console freezes before continuing. For example when saving configurations.
username
 no
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: admin
    password: admin
    transport: cli

- name: configure rollback location
  sros_rollback:
    rollback_location: "cb3:/ansible"
    provider: "{{ cli }}"

- name: remove all rollback configuration
  sros_rollback:
    state: absent
    provider: "{{ cli }}"

Return Values

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

name description returned type sample
updates The set of commands that will be pushed to the remote device always list ['...', '...']

This is a Core Module

For more information on what this means please read Core Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/sros_rollback_module.html