blob: 8edd50ee186ec05820d3a7d3741ae5a5a83b2e64 (
plain)
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
|
# Ansible Cisco Small Bussiness Switches (SMB) module
Ansible Galaxy module for Cisco SMB switches - SG300, SG500, SG350, SG550, CBS350
## Install
```
ansible-galaxy collection install community.ciscosmb
```
## Use
Tested on devices:
* SG350-10-K9
* SG350-28-K9
* SG500-52-K9
* SG550X-24MP-K9
* CBS350-24P-4G
* SG550X-48 stack
Tested on Python versions:
* 2.6
* 2.7
* 3.6
* 3.7
* 3.8
* 3.9
file `cismosmb_inventory.yml`
```yaml
all:
vars:
ansible_connection: network_cli
### change what you need
# ansible_ssh_private_key_file: /dir/private.key
# ansible_ssh_user: user
# ansible_ssh_pass: password
hosts:
switch1:
ansible_host: AAA.BBB.CCC.DDD
ansible_network_os: community.ciscosmb.ciscosmb
switch2:
ansible_host: WWW.XXX.YYY.ZZZ
ansible_network_os: community.ciscosmb.ciscosmb
```
playbook `ciscosmb_gather_facts.yml`
```yaml
- name: Gather Facts
gather_facts: no
hosts: all
vars:
- configs_dir: configs
tasks:
###
# Collect data
#
- name: CiscoSMB - Gather Facts - subset default
community.ciscosmb.facts:
gather_subset:
- default
# when: ansible_network_os == 'community.ciscosmb.ciscosmb'
- name: CiscoSMB - Gather Facts - subset config
community.ciscosmb.facts:
gather_subset:
- config
# when: ansible_network_os == 'community.ciscosmb.ciscosmb'
- name: Create configuration directory
local_action: file path={{ configs_dir }} state=directory
run_once: true
check_mode: no
changed_when: no
- name: Save running config
local_action: copy content={{ ansible_net_config }} dest={{ configs_dir }}/{{ inventory_hostname }}_net_config
```
Run
```
ansible-playbook -i ciscosmb_inventory.yml ciscosmb_gather_facts.yml
```
## Developement
### Setup environment
```
git clone https://github.com/ansible-collections/community.ciscosmb ansible_collections/community/ciscosmb
git clone --depth=1 --single-branch https://github.com/ansible-collections/ansible.netcommon.git ansible_collections/ansible/netcommon
cd ansible_collections/community/ciscosmb
python3 -m venv .venv
. .venv/bin/activate
pip install ansible
pip install -r requirements-dev.txt
pip install -r tests/unit/requirements.txt
```
### Develop
```
cd ansible_collections/community/ciscosmb
git pull
. .venv/bin/activate
# edit files
vim file
cp changelogs/fragments/.keep changelogs/fragments/fragment.yml
changelogs/fragments/fragment.yml
git commit -m "xxx" file
```
### Testing
```
cd ansible_collections/community/ciscosmb
. .venv/bin/activate
# PY="--python 3.8" # set your version or unset
METHOD="--docker" # or --local if you have no Docker installed
ansible-test sanity ${METHOD} ${PY} \
&& ansible-test units ${METHOD} ${PY} \
&& rm -f ./community-ciscosmb-*.tar.gz \
&& ansible-galaxy collection build -v --force \
&& export GALAXY_IMPORTER_CONFIG=./galaxy-importer.cfg \
&& python3 -m galaxy_importer.main ./community-ciscosmb-*.tar.gz \
&& rm -f ./community-ciscosmb-*.tar.gz
```
### Release
```
cd ansible_collections/community/ciscosmb
git pull
. .venv/bin/activate
# edit version in galaxy.yml
vim galaxy.yml
# edit changelog fragments (template in changelogs/fragments/.keep)
cp changelogs/fragments/.keep changelogs/fragments/fragment.yml
vim changelogs/fragments/fragment.yml
# generate CHANGELOG.rst
antsibull-changelog lint -v
antsibull-changelog release -v
git commit -m "version bump to x.y.z" .
git tag x.y.z
git push
```
## Releasing, Versioning and Deprecation
See [RELEASE_POLICY.md](https://github.com/ansible-collections/community.ciscosmb/blob/main/RELEASE_POLICY.md)
## Code of Conduct
See [CODE_OF_CONDUCT.md](https://github.com/ansible-collections/community.ciscosmb/blob/main/CODE_OF_CONDUCT.md)
## Contributing
See [CONTRIBUTING.md](https://github.com/ansible-collections/community.ciscosmb/blob/main/CONTRIBUTING.md)
|
