�
�Udac @` s2 d d l m Z m Z m Z e Z i d d 6d g d 6d d 6Z d Z d Z d
Z d d l
Z
d d l m Z m
Z
d d
l m Z d d l m Z d d l m Z m Z m Z d d l m Z m Z d d l m Z m Z d Z d � Z d � Z d � Z d � Z d � Z d � Z! e" d k r.e! � n d S( i ( t absolute_importt divisiont print_functions 1.1t metadata_versiont previewt statust networkt supported_bys
---
module: iosxr_config
version_added: "2.1"
author: "Ricardo Carrillo Cruz (@rcarrillocruz)"
short_description: Manage Cisco IOS XR configuration sections
description:
- Cisco IOS XR configurations use a simple block indent file syntax
for segmenting configuration into sections. This module provides
an implementation for working with IOS XR configuration sections in
a deterministic way.
extends_documentation_fragment: iosxr
notes:
- This module works with connection C(network_cli). See L(the IOS-XR Platform Options,../network/user_guide/platform_iosxr.html).
- Tested against IOS XRv 6.1.3.
- This module does not support C(netconf) connection
- Abbreviated commands are NOT idempotent, see
L(Network FAQ,../network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands).
- Avoid service disrupting changes (viz. Management IP) from config replace.
- Do not use C(end) in the replace config file.
options:
lines:
description:
- The ordered set of commands that should be configured in the
section. The commands must be the exact same commands as found
in the device running-config. Be sure to note the configuration
command syntax as some commands are automatically modified by the
device config parser.
aliases: ['commands']
parents:
description:
- The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top
level or global commands.
src:
description:
- Specifies the source path to the file that contains the configuration
or configuration template to load. The path to the source file can
either be the full path on the Ansible control host or a relative
path from the playbook or role root directory. This argument is mutually
exclusive with I(lines), I(parents).
version_added: "2.2"
before:
description:
- The ordered set of commands to push on to the command stack if
a change needs to be made. This allows the playbook designer
the opportunity to perform configuration commands prior to pushing
any changes without affecting how the set of commands are matched
against the system.
after:
description:
- The ordered set of commands to append to the end of the command
stack if a change needs to be made. Just like with I(before) this
allows the playbook designer to append a set of commands to be
executed after the command set.
match:
description:
- Instructs the module on the way to perform the matching of
the set of commands against the current device config. If
match is set to I(line), commands are matched line by line. If
match is set to I(strict), command lines are matched with respect
to position. If match is set to I(exact), command lines
must be an equal match. Finally, if match is set to I(none), the
module will not attempt to compare the source configuration with
the running configuration on the remote device.
default: line
choices: ['line', 'strict', 'exact', 'none']
replace:
description:
- Instructs the module on the way to perform the configuration
on the device. If the replace argument is set to I(line) then
the modified lines are pushed to the device in configuration
mode. If the replace argument is set to I(block) then the entire
command block is pushed to the device in configuration mode if any
line is not correct.
default: line
choices: ['line', 'block', 'config']
force:
description:
- The force argument instructs the module to not consider the
current devices running-config. When set to true, this will
cause the module to push the contents of I(src) into the device
without first checking if already configured.
- Note this argument should be considered deprecated. To achieve
the equivalent, set the C(match=none) which is idempotent. This argument
will be removed in a future release.
type: bool
default: 'no'
version_added: "2.2"
config:
description:
- The module, by default, will connect to the remote device and
retrieve the current running-config to use as a base for comparing
against the contents of source. There are times when it is not
desirable to have the task get the current running-config for
every task in a playbook. The I(config) argument allows the
implementer to pass in the configuration to use as the base
config for comparison.
backup:
description:
- This argument will cause the module to create a full backup of
the current C(running-config) from the remote device before any
changes are made. If the C(backup_options) value is not given,
the backup file is written to the C(backup) folder in the playbook
root directory or role root directory, if playbook is part of an
ansible role. If the directory does not exist, it is created.
type: bool
default: 'no'
version_added: "2.2"
comment:
description:
- Allows a commit description to be specified to be included
when the configuration is committed. If the configuration is
not changed or committed, this argument is ignored.
default: 'configured by iosxr_config'
version_added: "2.2"
admin:
description:
- Enters into administration configuration mode for making config
changes to the device.
type: bool
default: 'no'
version_added: "2.4"
label:
description:
- Allows a commit label to be specified to be included when the
configuration is committed. A valid label must begin with an alphabet
and not exceed 30 characters, only alphabets, digits, hyphens and
underscores are allowed. If the configuration is not changed or
committed, this argument is ignored.
version_added: "2.7"
backup_options:
description:
- This is a dict object containing configurable options related to backup file path.
The value of this option is read only when C(backup) is set to I(yes), if C(backup) is set
to I(no) this option will be silently ignored.
suboptions:
filename:
description:
- The filename to be used to store the backup configuration. If the the filename
is not given it will be generated based on the hostname, current time and date
in format defined by <hostname>_config.<current-date>@<current-time>
dir_path:
description:
- This option provides the path ending with directory name in which the backup
configuration file will be stored. If the directory does not exist it will be first
created and the filename is either the value of C(filename) or default filename
as described in C(filename) options description. If the path value is not given
in that case a I(backup) directory will be created in the current working directory
and backup configuration will be copied in C(filename) within I(backup) directory.
type: path
type: dict
version_added: "2.8"
exclusive:
description:
- Enters into exclusive configuration mode that locks out all users from committing
configuration changes until the exclusive session ends.
type: bool
default: false
version_added: "2.9"
s
- name: configure top level configuration
iosxr_config:
lines: hostname {{ inventory_hostname }}
- name: configure interface settings
iosxr_config:
lines:
- description test interface
- ip address 172.31.1.1 255.255.255.0
parents: interface GigabitEthernet0/0/0/0
- name: load a config from disk and replace the current config
iosxr_config:
src: config.cfg
replace: config
backup: yes
- name: for idempotency, use full-form commands
iosxr_config:
lines:
# - shut
- shutdown
# parents: int g0/0/0/1
parents: interface GigabitEthernet0/0/0/1
- name: configurable backup path
iosxr_config:
src: config.cfg
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
s2
commands:
description: The set of commands that will be pushed to the remote device
returned: If there are commands to run against the host
type: list
sample: ['hostname foo', 'router ospf 1', 'router-id 1.1.1.1']
backup_path:
description: The full path to the backup file
returned: when backup is yes
type: str
sample: /playbooks/ansible/backup/iosxr01_config.2016-07-16@22:28:34
filename:
description: The name of the backup file
returned: when backup is yes and filename is not specified in backup options
type: str
sample: iosxr01_config.2016-07-16@22:28:34
shortname:
description: The full path to the backup file excluding the timestamp
returned: when backup is yes and filename is not specified in backup options
type: str
sample: /playbooks/ansible/backup/iosxr01_config
date:
description: The date extracted from the backup file name
returned: when backup is yes
type: str
sample: "2016-07-16"
time:
description: The time extracted from the backup file name
returned: when backup is yes
type: str
sample: "22:28:34"
N( t to_textt to_bytes( t
AnsibleModule( t ConnectionError( t load_configt
get_configt get_connection( t iosxr_argument_spect copy_file( t
NetworkConfigt dumpss configured by iosxr_configc C` s\ d } t | d � } | j t | j d d d �� | j � d } t | | | d � t S( sl Copy config file to IOS-XR node. We use SFTP because older IOS-XR versions don't handle SCP very well.
s /tmp/ansible_config.txtt wbt srct errorst surrogate_or_stricts /harddisk:/ansible_config.txtt sftp( t opent writeR t paramst closeR t True( t moduleR t filet dst( ( sN /usr/lib/python2.7/site-packages/ansible/modules/network/iosxr/iosxr_config.pyt copy_file_to_node s
c C` s� | j d r< t | j d � d k r< | j d d � q< n | j d r� | j d } t | � d k r{ | j d d � n | d j � s� | j d d � n t j d
| � } | s� | j d d d � q� n | j d
r� | j d � n d S( Nt commenti< t msgs2 comment argument cannot be more than 60 characterst labeli s0 label argument cannot be more than 30 charactersi s* label argument must begin with an alphabets [\w-]*$s+ label argument must only contain alphabets,s digits, underscores or hyphenst forcesm The force argument is deprecated, please use match=none instead. This argument will be removed in the future( R t lent fail_jsont isalphat ret matcht append( R t warningsR# t valid_chars( ( sN /usr/lib/python2.7/site-packages/ansible/modules/network/iosxr/iosxr_config.pyt
check_args s
c C` s& | j d } | s" t | � } n | S( Nt config( R R
( R t contents( ( sN /usr/lib/python2.7/site-packages/ansible/modules/network/iosxr/iosxr_config.pyt get_running_config% s
c C` s� d } | j d r# | j d } n^ | j d r� t d d � } | j d pR t � } | j | j d d | �t | d � } n | S( Nt R t linest indenti t parentst raw( R R t listt addR ( R t candidatet
candidate_objR4 ( ( sN /usr/lib/python2.7/site-packages/ansible/modules/network/iosxr/iosxr_config.pyt
get_candidate, s
c C` s� | j d } | j d } | d k } | j d } | j d } | j d } | j d } | j } | j d }
t | � } t | � } d }
d } t | � } y. | j d | d
| d | d | d
| � } Wn/ t k
r� } | j d t | d d �� n X| j
d � } | r�| j d | d
| d | d | d
| � } | sO| d r�t | � } | st| j d d � n d g }
d } q�n | s�|
r�| s�| j d � }
n t
| j d | j d f � r | j d r�| j d |
d *n | j d r|
j | j d � n |
| d <n | } t | |
d | d | d | d | d | d |
�} | rut d | � | d <n t | d <n d S( NR) t replaceR. R4 R! t admint exclusiveR# R8 t runningt
diff_matcht patht diff_replaceR" R t surrogate_then_replacet config_diffs& Copy of config file to the node faileds! load harddisk:/ansible_config.txts harddisk:/ansible_config.txts
R2 R t beforei t aftert commandst committ preparedt difft changed( R t
check_modeR: R0 t NoneR t get_diffR R& R t getR t splitt anyt extendR t dictR ( R t resultR) R; t replace_configR@ R! R< R= RK R# t candidate_configt running_configRF t replace_file_patht
connectiont responset excRC t running_base_diff_respt retRG RI ( ( sN /usr/lib/python2.7/site-packages/ansible/modules/network/iosxr/iosxr_config.pyt run8 sX
. *
c ! C` sr t d t � d t d d � � } t d t d d � d t d d g d d � d
t d d � d t d d � d t d d � d
t d d d d d d d g � d t d d d d d d g � d t d t d d � d t � d t d d d t � d t d d d | � d t d t � d t d d d t � d t d d d t � d t � � } | j t � d) d* g } d
d d g f d
d d g f d d d g f d d d g f g } t d! | d" | d# | d$ t � } | j d t k r�d | j d
<n t � } t | | � t d% t d& | � } | j d r1t
| � | d' <n t | j d | j d f � rat | | � n | j
| � d( S(+ s* main entry point for module execution
t filenamet dir_patht typeR@ R R2 t aliasesRF R6 R4 RD RE R) t defaultt linet choicest strictt exactt noneR; t blockR. R$ t boolt backupt backup_optionsRR t optionsR! R< R= R# t
argument_spect mutually_exclusivet required_ift supports_check_modeRJ R+ t
__backup__N( R2 R ( R4 R ( RR t Falset DEFAULT_COMMIT_COMMENTt updateR R
R R R6 R- R
RP R] t exit_json( t backup_specRm Rn Ro R R+ RS ( ( sN /usr/lib/python2.7/site-packages/ansible/modules/network/iosxr/iosxr_config.pyt mains sP !
t __main__(# t
__future__R R R R` t
__metaclass__t ANSIBLE_METADATAt
DOCUMENTATIONt EXAMPLESt RETURNR( t ansible.module_utils._textR R t ansible.module_utils.basicR
t ansible.module_utils.connectionR t( ansible.module_utils.network.iosxr.iosxrR R
R R R t* ansible.module_utils.network.common.configR R Rs R R- R0 R: R] Rw t __name__( ( ( sN /usr/lib/python2.7/site-packages/ansible/modules/network/iosxr/iosxr_config.pyt <module> s.
�#! ; @
Anons79 File Manager Version 1.0, Coded By Anons79
Email: [email protected]
Anons79 Mini Shell