�
�Udac @ s$ i d d 6d g d 6d d 6Z d Z d Z d Z d d
l Z d d l m Z d d l m Z d d
l m
Z
m Z d d l m Z m
Z
d d l m Z d d l m Z d d l m Z d d l m Z m Z d � Z d � Z d � Z d
d
d � Z d � Z d � Z e d k r e � n d
S( s 1.1t metadata_versiont previewt statust networkt supported_bys\#
---
module: ios_config
version_added: "2.1"
author: "Peter Sprygada (@privateip)"
short_description: Manage Cisco IOS configuration sections
description:
- Cisco IOS configurations use a simple block indent file syntax
for segmenting configuration into sections. This module provides
an implementation for working with IOS configuration sections in
a deterministic way.
extends_documentation_fragment: ios
notes:
- Tested against IOS 15.6
- 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).
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.
choices: ['line', 'strict', 'exact', 'none']
default: line
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']
multiline_delimiter:
description:
- This argument is used when pushing a multiline configuration
element to the IOS device. It specifies the character to use
as the delimiting character. This only applies to the
configuration action.
default: "@"
version_added: "2.3"
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"
running_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(running_config) argument allows the
implementer to pass in the configuration to use as the base
config for comparison.
aliases: ['config']
version_added: "2.4"
defaults:
description:
- This argument specifies whether or not to collect all defaults
when getting the remote device running config. When enabled,
the module will get the current config by issuing the command
C(show running-config all).
type: bool
default: 'no'
version_added: "2.2"
save_when:
description:
- When changes are made to the device running-configuration, the
changes are not copied to non-volatile storage by default. Using
this argument will change that before. If the argument is set to
I(always), then the running-config will always be copied to the
startup-config and the I(modified) flag will always be set to
True. If the argument is set to I(modified), then the running-config
will only be copied to the startup-config if it has changed since
the last save to startup-config. If the argument is set to
I(never), the running-config will never be copied to the
startup-config. If the argument is set to I(changed), then the running-config
will only be copied to the startup-config if the task has made a change.
I(changed) was added in Ansible 2.5.
default: never
choices: ['always', 'never', 'modified', 'changed']
version_added: "2.4"
diff_against:
description:
- When using the C(ansible-playbook --diff) command line argument
the module can generate diffs against different sources.
- When this option is configure as I(startup), the module will return
the diff of the running-config against the startup-config.
- When this option is configured as I(intended), the module will
return the diff of the running-config against the configuration
provided in the C(intended_config) argument.
- When this option is configured as I(running), the module will
return the before and after diff of the running-config with respect
to any changes made to the device configuration.
choices: ['running', 'startup', 'intended']
version_added: "2.4"
diff_ignore_lines:
description:
- Use this argument to specify one or more lines that should be
ignored during the diff. This is used for lines in the configuration
that are automatically updated by the system. This argument takes
a list of regular expressions or exact line matches.
version_added: "2.4"
intended_config:
description:
- The C(intended_config) provides the master configuration that
the node should conform to and is used to check the final
running-config against. This argument will not modify any settings
on the remote device and is strictly used to check the compliance
of the current device's configuration against. When specifying this
argument, the task should also modify the C(diff_against) value and
set it to I(intended).
version_added: "2.4"
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"
s
- name: configure top level configuration
ios_config:
lines: hostname {{ inventory_hostname }}
- name: configure interface settings
ios_config:
lines:
- description test interface
- ip address 172.31.1.1 255.255.255.0
parents: interface Ethernet1
- name: configure ip helpers on multiple interfaces
ios_config:
lines:
- ip helper-address 172.26.1.10
- ip helper-address 172.26.3.8
parents: "{{ item }}"
with_items:
- interface Ethernet1
- interface Ethernet2
- interface GigabitEthernet1
- name: configure policer in Scavenger class
ios_config:
lines:
- conform-action transmit
- exceed-action drop
parents:
- policy-map Foo
- class Scavenger
- police cir 64000
- name: load new acl into device
ios_config:
lines:
- 10 permit ip host 192.0.2.1 any log
- 20 permit ip host 192.0.2.2 any log
- 30 permit ip host 192.0.2.3 any log
- 40 permit ip host 192.0.2.4 any log
- 50 permit ip host 192.0.2.5 any log
parents: ip access-list extended test
before: no ip access-list extended test
match: exact
- name: check the running-config against master config
ios_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: check the startup-config against the running-config
ios_config:
diff_against: startup
diff_ignore_lines:
- ntp clock .*
- name: save running to startup when modified
ios_config:
save_when: modified
- name: for idempotency, use full-form commands
ios_config:
lines:
# - shut
- shutdown
# parents: int gig1/0/11
parents: interface GigabitEthernet1/0/11
# Set boot image based on comparison to a group_var (version) and the version
# that is returned from the `ios_facts` module
- name: SETTING BOOT IMAGE
ios_config:
lines:
- no boot system
- boot system flash bootflash:{{new_image}}
host: "{{ inventory_hostname }}"
when: ansible_net_version != version
- name: render a Jinja2 template onto an IOS device
ios_config:
backup: yes
src: ios_template.j2
- name: configurable backup path
ios_config:
src: ios_template.j2
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
s�
updates:
description: The set of commands that will be pushed to the remote device
returned: always
type: list
sample: ['hostname foo', 'router ospf 1', 'router-id 192.0.2.1']
commands:
description: The set of commands that will be pushed to the remote device
returned: always
type: list
sample: ['hostname foo', 'router ospf 1', 'router-id 192.0.2.1']
backup_path:
description: The full path to the backup file
returned: when backup is yes
type: str
sample: /playbooks/ansible/backup/ios_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: ios_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/ios_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"
i����N( t to_text( t ConnectionError( t run_commandst
get_config( t get_defaults_flagt get_connection( t ios_argument_spec( t
check_args( t
AnsibleModule( t
NetworkConfigt dumpsc C sM t | | � | j d rI t | j d � d k rI | j d d � qI n d S( Nt multiline_delimiteri t msgs8 multiline_delimiter value can only be a single character( t ios_check_argst paramst lent fail_json( t modulet warnings( ( sJ /usr/lib/python2.7/site-packages/ansible/modules/network/ios/ios_config.pyR ^ s
c C s: | d j d � r& | j d | � n | j d | � d S( Ni s
macro namet candidate( t
startswitht
edit_macrot edit_config( t
connectiont commands( ( sJ /usr/lib/python2.7/site-packages/ansible/modules/network/ios/ios_config.pyt edit_config_or_macrof 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 t srct linest indenti t parentst raw( R R t listt addR ( R R t
candidate_objR# ( ( sJ /usr/lib/python2.7/site-packages/ansible/modules/network/ios/ios_config.pyt get_candidate_configo s
c C sI | j d } | sE | j d r0 | r0 | } qE t | d | �} n | S( Nt running_configt defaultst flags( R R ( R t current_configR+ t running( ( sJ /usr/lib/python2.7/site-packages/ansible/modules/network/ios/ios_config.pyt get_running_config} s
c C s4 t | d <| j s# t | d � n
| j d � d S( Nt changeds# copy running-config startup-config
sz Skipping command `copy running-config startup-config` due to check_mode. Configuration not copied to non-volatile storage( t Truet
check_modeR t warn( R t result( ( sJ /usr/lib/python2.7/site-packages/ansible/modules/network/ios/ios_config.pyt save_config� s
c # C s. 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 g � d t d d � d t 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 d" d# d$ d% g d d# � d& t d d' d( d) g � d* t d d � � } | j t � dG dH 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 � } i t d% 6} t � } t | | � | | d/ <| j d* } dF } dF } | j d rFt
| � n g }
t | � } | j d s�| j r�| j d& d) k r�t
| d0 |
�} t d1 d2 d3 | � } | j d r�| | d4 <q�n t | j d | j d f � r�| j d
} | j d }
| j d
} t | � } t | | d0 |
�} y4 | j d5 | d) | d6 | d* | d | d7 |
� } Wn/ t k
r�} | j d8 t | d9 d: �� n X| d; } | d< } | s�| r�| j d= � } | j d r�| j d | d> *n | j d r| j | j d � n | | d <| | d? <| | d@ <| j sv| rDt | | � n | rv| j d5 t j | � d | j d � qvn t | d% <q�n | j d } dF } | j d! d" k r�t | | � n� | j d! d$ k rGt | dA dB g � } t d1 d2 d3 | d> dC | � } t d1 d2 d3 | d2 dC | � } | j | j k rtt | | � qtn- | j d! d% k rt| d% rtt | | � n | j r | s�t | dA � } | d> } n | } t d1 d2 d3 | dC | � } | j d& d) k r�| j r�| j dD � dF } qb| j! } nd | j d& d' k r?| s3t | dB � } | d> } qb| j! } n# | j d& d( k rb| j d } n | dF k r t d1 d2 d3 | dC | � } | j | j k r| j d& d( k r�| } | } n" | j d& dI k r�| } | } n | j i t d% 6i t" | � d 6t" | � d 6dE 6� qq n | j# | � dF S(J s+ main entry point for module execution
t filenamet dir_patht typet pathR R! t aliasesR R% R# t beforet aftert matcht defaultt linet choicest strictt exactt nonet replacet blockR t @R) t configt intended_configR* t boolt backupt backup_optionst dictt optionst save_whent alwayst nevert modifiedR/ t diff_againstt startupt intendedR- t diff_ignore_linest
argument_spect mutually_exclusivet required_ift supports_check_modeR R+ R" i t contentst
__backup__R t
diff_matcht diff_replaceR t errorst surrogate_then_replacet config_difft banner_diffs
i t updatest bannerss show running-configs show startup-configt ignore_liness? unable to perform diff against running-config due to check modet diffN( R! R ( R# R ( RR s running($ RK t Falset updateR R
R0 R% R R t NoneR R
t _diffR R t anyR( R. t get_diffR R R t splitt extendR1 R t edit_bannert jsonR R4 R t sha1R2 t config_textt strt exit_json( t backup_specRU RV RW R R3 R RT RF RY R+ R R< RC R8 R R- t responset excR_ R` R R) t startup_configt outputt base_configR: R; ( ( sJ /usr/lib/python2.7/site-packages/ansible/modules/network/ios/ios_config.pyt main� s� ! !
)
'
,
.t __main__( t ANSIBLE_METADATAt
DOCUMENTATIONt EXAMPLESt RETURNRn t ansible.module_utils._textR t ansible.module_utils.connectionR t$ ansible.module_utils.network.ios.iosR R R R
R R R t ansible.module_utils.basicR
t* ansible.module_utils.network.common.configR R R R( Rg R. R4 Ry t __name__( ( ( sJ /usr/lib/python2.7/site-packages/ansible/modules/network/ios/ios_config.pyt <module> s,
�\&
�
Anons79 File Manager Version 1.0, Coded By Anons79
Email: [email protected]
Anons79 Mini Shell