1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
#!/usr/bin/python
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
module: ios_banner
author: Ricardo Carrillo Cruz (@rcarrillocruz)
short_description: Module to configure multiline banners.
description:
- This will configure both login and motd banners on remote devices running Cisco
IOS. It allows playbooks to add or remote banner text from the active running configuration.
version_added: 1.0.0
extends_documentation_fragment:
- cisco.ios.ios
notes:
- Tested against Cisco IOSXE Version 17.3 on CML.
- This module works with connection C(network_cli).
See U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html)
options:
banner:
description:
- Specifies which banner should be configured on the remote device. In Ansible
2.4 and earlier only I(login) and I(motd) were supported.
required: true
choices:
- login
- motd
- exec
- incoming
- slip-ppp
type: str
multiline_delimiter:
description:
- Specify the delimiting character than will be used for configuration.
default: "@"
type: str
text:
description:
- The banner text that should be present in the remote device running configuration. This
argument accepts a multiline string, with no empty lines. Requires I(state=present).
type: str
state:
description:
- Specifies whether or not the configuration is present in the current devices
active running configuration.
default: present
type: str
choices:
- present
- absent
"""
EXAMPLES = """
- name: Configure the login banner
cisco.ios.ios_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: Remove the motd banner
cisco.ios.ios_banner:
banner: motd
state: absent
- name: Configure banner from file
cisco.ios.ios_banner:
banner: motd
text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" # Use unix formatted text files (LF not CRLF) to avoid idempotency issues.
state: present
- name: Configure the login banner using delimiter
cisco.ios.ios_banner:
banner: login
multiline_delimiter: x
text: this is my login banner
state: present
"""
RETURN = """
commands:
description: The list of configuration mode commands to send to the device
returned: always
type: list
sample:
- banner login
- this is my login banner
- that contains a multiline
- string
"""
from re import M, search
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.cisco.ios.plugins.module_utils.network.ios.ios import (
get_config,
load_config,
)
def map_obj_to_commands(updates, module):
commands = list()
want, have = updates
state = module.params["state"]
multiline_delimiter = module.params.get("multiline_delimiter")
if state == "absent" and "text" in have.keys() and have["text"]:
commands.append("no banner %s" % module.params["banner"])
elif state == "present":
if have.get("text") and len(have.get("text")) > 1:
haved = have.get("text").rstrip("\n")
else:
haved = ""
if want["text"] and (want["text"].rstrip("\n") != haved):
banner_cmd = "banner %s" % module.params["banner"]
banner_cmd += " {0}\n".format(multiline_delimiter)
banner_cmd += want["text"].strip("\n")
banner_cmd += "\n{0}".format(multiline_delimiter)
commands.append(banner_cmd)
return commands
def map_config_to_obj(module):
"""
This function gets the banner config without stripping any whitespaces,
and then fetches the required banner from it.
:param module:
:return: banner config dict object.
"""
out = get_config(module, flags="| begin banner %s" % module.params["banner"])
if out:
regex = search("banner " + module.params["banner"] + " \\^C{1,}\n", out, M)
if regex:
regex = regex.group()
output = str((out.split(regex))[1].split("^C\n")[0])
else:
output = None
else:
output = None
obj = {"banner": module.params["banner"], "state": "absent"}
if output:
obj["text"] = output
obj["state"] = "present"
return obj
def map_params_to_obj(module):
text = module.params["text"]
return {
"banner": module.params["banner"],
"text": text,
"multiline_delimiter": module.params["multiline_delimiter"],
"state": module.params["state"],
}
def main():
"""main entry point for module execution"""
argument_spec = dict(
banner=dict(required=True, choices=["login", "motd", "exec", "incoming", "slip-ppp"]),
multiline_delimiter=dict(default="@"),
text=dict(),
state=dict(default="present", choices=["present", "absent"]),
)
required_if = [("state", "present", ("text",))]
module = AnsibleModule(
argument_spec=argument_spec,
required_if=required_if,
supports_check_mode=True,
)
warnings = list()
result = {"changed": False}
if warnings:
result["warnings"] = warnings
want = map_params_to_obj(module)
have = map_config_to_obj(module)
commands = map_obj_to_commands((want, have), module)
result["commands"] = commands
if commands:
if not module.check_mode:
load_config(module, commands)
result["changed"] = True
module.exit_json(**result)
if __name__ == "__main__":
main()
|
