Merge pull request #320 from netscaler/support-action-operation

### Added

- introduced new states -- `created` and `imported` ([#295])

### Fixed

- removed default values in `nitro_resource_map.py` ([#313], [#314], [#311])
- default monitor can now be unbound from service ([#312])
- `ip` is now not mandatory for server based resources ([#297])

CHANGELOG.md

@@ -7,14 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.0] - 2023-12-17
+
+### Added
+
+- introduced new states -- `created` and `imported` ([#295])
+
+### Fixed
+
+- removed default values in `nitro_resource_map.py` ([#313], [#314], [#311])
+- default monitor can now be unbound from service ([#312])
+- `ip` is now not mandatory for server based resources ([#297])
+
 ## [2.0.3] - 2023-11-14
 
 > No module specific changes in this release
 
 - updated documentation
 - updated supported_modules_matrix.md
 - added GitHub workflows
-- updated GitHub issue and feature template 
+- updated GitHub issue and feature template
 
 ## [2.0.2] - 2023-11-08
 
@@ -35,11 +47,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial Release
 
-[unreleased]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.0.3...HEAD
+[unreleased]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.1.0...HEAD
+[2.1.0]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.0.3...2.1.0
 [2.0.3]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.0.2...2.0.3
 [2.0.2]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.0.1...2.0.2
 [2.0.1]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/netscaler/ansible-collection-netscaleradc/releases/tag/2.0.0
-
 [#288]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/288
 [#286]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/286
+[#295]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/295
+[#297]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/297
+[#311]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/311
+[#312]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/312
+[#313]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/313
+[#314]: https://github.com/netscaler/ansible-collection-netscaleradc/issues/314

CONTRIBUTING.md

@@ -8,5 +8,6 @@ Not every contribution comes in the form of code. Submitting, confirming, and tr
 
 We ask you not to submit security concerns via GitHub. For details on submitting potential security issues please see <https://support.citrix.com/article/CTX081743>
 
-## Code Contributions 
+## Code Contributions
+
 At this point we are not accepting code contributions from outside NetScaler. Please raise an issue if you wish to see a feature.

Makefile

@@ -43,7 +43,8 @@ lint: install
 # 	pip3 install -r requirements.txt
 # 	./build.sh
 # 	cd ..
-# 	rsync -cprv _built_docs/build/html/ docs/ # Do not use --delete-after as this will delete .nojekyll file
+# 	rsync -cprv _built_docs/build/html/ docs/ --delete-after # Do not use --delete-after as this will delete .nojekyll file
+# 	git restore docs/.nojekyll
 
 
 # Run examples/*.yaml playbooks individually
@@ -52,7 +53,7 @@ lint: install
 # skip the playbook which contains "password" in the file name
 run_examples:
 	@for playbook in examples/*.yaml; do \
-		if [[ $$playbook == *"password"* ]]; then \
+		if [[ $$playbook == *"password"* || $$playbook == *"login"* || $$playbook == *"logout"* || $$playbook == *"route"* || $$playbook == locationfile.yaml || $$playbook == nsip6.yaml ]]; then \
 			continue; \
 		fi; \
 		echo "Running $$playbook"; \

README.md

@@ -1,16 +1,16 @@
 # NetScaler Ansible Collection `version2` - netscaler.adc
 
-
 > ⚠️ Note:
 > The earlier `citrix.adc` ansible collection is replaced with the new `netscaler.adc` ansible collection.
+
 > The `citrix.adc` ansible collection is backed up by a seperate branch [citrix.adc](https://github.com/netscaler/ansible-collection-netscaleradc/tree/citrix.adc)
 
 
 ## Vision
 
 The vision of the `netscaler.adc` collection is to provide a complete declarative interface to configure and manage NetScaler ADC.
 
-If you need any feature or flexibility that is not available in the collection, please raise issues/enhancement-requests/recommendations at <https://github.com/netscaler/ansible-collection-netscaleradc/issues>
+If you need any feature or flexibility that is not available in the collection at the moment, please raise issues/enhancement-requests/recommendations at <https://github.com/netscaler/ansible-collection-netscaleradc/issues>
 
 > :envelope: For any immediate issues or help , reach out to us at <[email protected]> !
 
@@ -20,9 +20,9 @@ We refer the earlier `citrix.adc` ansible collection as `version1` and the new `
 
 This is the `version2` of the NetScaler Ansible Collection. It is a complete rewrite of the collection. The collection is not backward compatible with the `version1` of the collection.
 
-`citrix.adc` collection will be deprecated soon and will not be maintained further. Please migrate to `netscaler.adc` of the collection.
+`citrix.adc` collection will be deprecated soon and will not be maintained further. It is recommended to migrate to the `netscaler.adc` collection.
 
-## About the collection (version2)
+## About the `netscaler.adc` collection (version2)
 
 The collection provides Ansible modules to configure and manage NetScaler ADC appliances. The modules are written using the NITRO API. The modules are idempotent and can be used to configure the NetScaler ADC appliances in declarative manner.
 
@@ -38,9 +38,10 @@ ansible-galaxy collection install netscaler.adc
 
 
 ```bash
-git clone --single-branch https://github.com/netscaler/ansible-collection-netscaleradc.git /tmp/ansible-collection-netscaleradc && ansible-galaxy collection install /tmp/ansible-collection-netscaleradc --force
+ansible-galaxy collection install "git+https://github.com/citrix/citrix-adc-ansible-modules.git" [--force]
 ```
 
+> `--force` option is required if you have already installed the collection via ansible-galaxy. This will overwrite the existing collection with the latest collection from github.
 
 ### Verify the installation
 
@@ -132,12 +133,10 @@ Refer to the [supported_modules_matrix.md](supported_modules_matrix.md) file for
 - [ ] Add more examples
 - [ ] Write a python script which converts examples/playbook.yaml to module's EXAMPLE documentation
 - [ ] SSH Connection module
-- [ ] Run `ansible-test` on the collection.
-- [ ] Run `ansible-lint` on the collection for Python 2.7, 3.6, 3.7, 3.8 and 3.9.
 - [ ] Test modules against all NetScaler ADC versions.
-- [ ] Test modules againsts ansible versions 2.9+
-- [ ] Configure GitHub Actions to automate the collection build and release process.
+- [x] Test modules againsts ansible versions 2.9+
+- [x] Configure GitHub Actions to automate the collection build and release process.
 - [ ] Configure GitHub Actions to automate the collection documentation build and release process.
 - [ ] Configure GitHub Actions to automate the collection testing process.
-- [ ] Configure GitHub Actions to automate the collection linting process.
+- [x] Configure GitHub Actions to automate the collection linting process.
 - [x] Collect NetScaler info (version, etc) and store it in the `facts` dictionary

docs/collections/netscaler/adc/aaacertparams_module.html

@@ -131,7 +131,7 @@
 <h1>netscaler.adc.aaacertparams module – Configuration for certificate parameter resource.<a class="headerlink" href="#netscaler-adc-aaacertparams-module-configuration-for-certificate-parameter-resource" title="Link to this heading"></a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.0.2).</p>
+<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.1.0).</p>
 <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
 To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
 <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">netscaler.adc</span></code>.</p>
@@ -246,9 +246,11 @@ <h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a clas
 </div></td>
 <td><div class="ansible-option-cell"><p>The state of the resource being configured by the module on the NetScaler ADC node.</p>
 <p>When <code class="docutils literal notranslate"><span class="pre">present</span></code> the resource will be created if needed and configured according to the module’s parameters.</p>
+<p>When <code class="docutils literal notranslate"><span class="pre">absent</span></code> the resource will be deleted from the NetScaler ADC node.</p>
 <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
 <ul class="simple">
 <li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;present&quot;</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;absent&quot;</span></code></p></li>
 </ul>
 </div></td>
 </tr>

docs/collections/netscaler/adc/aaaglobal_aaapreauthenticationpolicy_binding_module.html

@@ -131,7 +131,7 @@
 <h1>netscaler.adc.aaaglobal_aaapreauthenticationpolicy_binding module – Binding Resource definition for describing association between aaaglobal and aaapreauthenticationpolicy resources<a class="headerlink" href="#netscaler-adc-aaaglobal-aaapreauthenticationpolicy-binding-module-binding-resource-definition-for-describing-association-between-aaaglobal-and-aaapreauthenticationpolicy-resources" title="Link to this heading"></a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.0.2).</p>
+<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.1.0).</p>
 <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
 To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
 <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">netscaler.adc</span></code>.</p>

docs/collections/netscaler/adc/aaaglobal_authenticationnegotiateaction_binding_module.html

@@ -131,7 +131,7 @@
 <h1>netscaler.adc.aaaglobal_authenticationnegotiateaction_binding module – Binding Resource definition for describing association between aaaglobal and authenticationnegotiateaction resources<a class="headerlink" href="#netscaler-adc-aaaglobal-authenticationnegotiateaction-binding-module-binding-resource-definition-for-describing-association-between-aaaglobal-and-authenticationnegotiateaction-resources" title="Link to this heading"></a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.0.2).</p>
+<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.1.0).</p>
 <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
 To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
 <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">netscaler.adc</span></code>.</p>

docs/collections/netscaler/adc/aaagroup_aaauser_binding_module.html

@@ -131,7 +131,7 @@
 <h1>netscaler.adc.aaagroup_aaauser_binding module – Binding Resource definition for describing association between aaagroup and aaauser resources<a class="headerlink" href="#netscaler-adc-aaagroup-aaauser-binding-module-binding-resource-definition-for-describing-association-between-aaagroup-and-aaauser-resources" title="Link to this heading"></a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.0.2).</p>
+<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.1.0).</p>
 <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
 To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
 <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">netscaler.adc</span></code>.</p>

docs/collections/netscaler/adc/aaagroup_auditnslogpolicy_binding_module.html

@@ -131,7 +131,7 @@
 <h1>netscaler.adc.aaagroup_auditnslogpolicy_binding module – Binding Resource definition for describing association between aaagroup and auditnslogpolicy resources<a class="headerlink" href="#netscaler-adc-aaagroup-auditnslogpolicy-binding-module-binding-resource-definition-for-describing-association-between-aaagroup-and-auditnslogpolicy-resources" title="Link to this heading"></a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.0.2).</p>
+<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.1.0).</p>
 <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
 To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
 <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">netscaler.adc</span></code>.</p>
@@ -287,7 +287,7 @@ <h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a clas
 <td><div class="ansible-option-cell"><p>Bindpoint to which the policy is bound.</p>
 <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
 <ul class="simple">
-<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;REQUEST&quot;</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;REQUEST&quot;</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;UDP_REQUEST&quot;</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;DNS_REQUEST&quot;</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ICMP_REQUEST&quot;</span></code></p></li>

docs/collections/netscaler/adc/aaagroup_auditsyslogpolicy_binding_module.html

@@ -131,7 +131,7 @@
 <h1>netscaler.adc.aaagroup_auditsyslogpolicy_binding module – Binding Resource definition for describing association between aaagroup and auditsyslogpolicy resources<a class="headerlink" href="#netscaler-adc-aaagroup-auditsyslogpolicy-binding-module-binding-resource-definition-for-describing-association-between-aaagroup-and-auditsyslogpolicy-resources" title="Link to this heading"></a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.0.2).</p>
+<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/netscaler/adc/">netscaler.adc collection</a> (version 2.1.0).</p>
 <p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
 To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
 <p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">netscaler.adc</span></code>.</p>
@@ -287,7 +287,7 @@ <h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a clas
 <td><div class="ansible-option-cell"><p>Bindpoint to which the policy is bound.</p>
 <p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
 <ul class="simple">
-<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;REQUEST&quot;</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;REQUEST&quot;</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;UDP_REQUEST&quot;</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;DNS_REQUEST&quot;</span></code></p></li>
 <li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;ICMP_REQUEST&quot;</span></code></p></li>