Merge pull request #247 from CiscoDevNet/3.4.0

Release 3.4.0
CiscoDevNet · Aug 16, 2023 · 0d791f9 · 0d791f9
2 parents 917ed0b + a285487
commit 0d791f9
Show file tree

Hide file tree

Showing 32 changed files with 2,574 additions and 273 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,7 +27,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-* Support to configure muliple interfaces for vrf_lite on a vrf
+* Support to configure multiple interfaces for vrf_lite on a vrf
 * Added support for more switch roles in inventory module.
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ You can also include it in a `requirements.yml` file and install it with `ansibl
 ---
 collections:
   - name: cisco.dcnm
-    version: 3.3.1
+    version: 3.4.0
 ```
 ## Using this collection
 
@@ -140,6 +140,7 @@ ansible_ssh_pass=dcnm_password
 ansible_network_os=cisco.dcnm.dcnm
 ansible_httpapi_validate_certs=False
 ansible_httpapi_use_ssl=True
+ansible_httpapi_login_domain=local
 ```
 
 * Ansible YAML Format
@@ -152,6 +153,7 @@ all:
     ansible_python_interpreter: python
     ansible_httpapi_validate_certs: False
     ansible_httpapi_use_ssl: True
+    ansible_httpapi_login_domain: local
   children:
     dcnm_controllers:
       hosts:
@@ -195,5 +197,3 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-
-
diff --git a/docs/cisco.dcnm.dcnm_httpapi.rst b/docs/cisco.dcnm.dcnm_httpapi.rst
@@ -22,6 +22,42 @@ Synopsis
 
 
 
+Parameters
+----------
+
+.. raw:: html
+
+    <table  border=0 cellpadding=0 class="documentation-table">
+        <tr>
+            <th colspan="1">Parameter</th>
+            <th>Choices/<font color="blue">Defaults</font></th>
+                <th>Configuration</th>
+            <th width="100%">Comments</th>
+        </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>login_domain</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"local"</div>
+                </td>
+                    <td>
+                                <div>env:ANSIBLE_HTTPAPI_LOGIN_DOMAIN</div>
+                                <div>var: ansible_httpapi_login_domain</div>
+                    </td>
+                <td>
+                        <div>The login domain name to use for user authentication</div>
+                        <div>Only needed for NDFC</div>
+                </td>
+            </tr>
+    </table>
+    <br/>
+
 
 
 

diff --git a/docs/cisco.dcnm.dcnm_interface_module.rst b/docs/cisco.dcnm.dcnm_interface_module.rst
@@ -2431,6 +2431,28 @@ Parameters
                 </td>
             </tr>
 
+            <tr>
+                <td colspan="3">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>deploy</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                    </div>
+                </td>
+                <td>
+                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                    <li>no</li>
+                                    <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
+                        </ul>
+                </td>
+                <td>
+                        <div>Flag indicating if the configuration must be pushed to the switch. This flag is used to decide the deploy behavior in &#x27;deleted&#x27; and &#x27;overridden&#x27; states as mentioned below</div>
+                        <div>In &#x27;overridden&#x27; state this flag will be used to deploy deleted interfaces.</div>
+                        <div>In &#x27;deleted&#x27; state this flag will be used to deploy deleted interfaces when a specific &#x27;config&#x27; block is not included.</div>
+                        <div>The &#x27;deploy&#x27; flags included with individual interface configuration elements under the &#x27;config&#x27; block will take precedence over this global flag.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="3">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>

diff --git a/docs/cisco.dcnm.dcnm_inventory_module.rst b/docs/cisco.dcnm.dcnm_inventory_module.rst
@@ -149,6 +149,40 @@ Parameters
                         <div>For other supported config data please refer to NDFC/DCNM configuration guide.</div>
                 </td>
             </tr>
+            <tr>
+                    <td class="elbow-placeholder"></td>
+                    <td class="elbow-placeholder"></td>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>discovery_password</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>Password for device discovery during POAP and RMA discovery</div>
+                </td>
+            </tr>
+            <tr>
+                    <td class="elbow-placeholder"></td>
+                    <td class="elbow-placeholder"></td>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>discovery_username</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>Username for device discovery during POAP and RMA discovery</div>
+                </td>
+            </tr>
             <tr>
                     <td class="elbow-placeholder"></td>
                     <td class="elbow-placeholder"></td>
@@ -317,6 +351,40 @@ Parameters
                         <div>For other supported config data please refer to NDFC/DCNM configuration guide.</div>
                 </td>
             </tr>
+            <tr>
+                    <td class="elbow-placeholder"></td>
+                    <td class="elbow-placeholder"></td>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>discovery_password</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>Password for device discovery during POAP and RMA discovery</div>
+                </td>
+            </tr>
+            <tr>
+                    <td class="elbow-placeholder"></td>
+                    <td class="elbow-placeholder"></td>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>discovery_username</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>Username for device discovery during POAP and RMA discovery</div>
+                </td>
+            </tr>
             <tr>
                     <td class="elbow-placeholder"></td>
                     <td class="elbow-placeholder"></td>
@@ -475,6 +543,25 @@ Parameters
                 </td>
             </tr>
 
+            <tr>
+                <td colspan="3">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>deploy</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                    </div>
+                </td>
+                <td>
+                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                    <li>no</li>
+                                    <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
+                        </ul>
+                </td>
+                <td>
+                        <div>Deploy the pending configuration of the fabric after inventory is updated</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="3">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -510,6 +597,25 @@ Parameters
                         <div>Query for Bootstrap(POAP) capable switches available.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="3">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>save</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                    </div>
+                </td>
+                <td>
+                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                    <li>no</li>
+                                    <li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
+                        </ul>
+                </td>
+                <td>
+                        <div>Save/Recalculate the configuration of the fabric after the inventory is updated</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="3">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>

diff --git a/galaxy.yml b/galaxy.yml
@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: dcnm
-version: 3.3.1
+version: 3.4.0
 readme: README.md
 authors:
   - Shrishail Kariyappanavar <nkshrishail>

diff --git a/plugins/httpapi/dcnm.py b/plugins/httpapi/dcnm.py
@@ -26,6 +26,17 @@
     a connection to the DCNM controller, send API requests and process the
     respsonse from the controller.
 version_added: "0.9.0"
+options:
+  login_domain:
+    description:
+    - The login domain name to use for user authentication
+    - Only needed for NDFC
+    type: string
+    default: local
+    env:
+    - name: ANSIBLE_HTTPAPI_LOGIN_DOMAIN
+    vars:
+    - name: ansible_httpapi_login_domain
 """
 
 import json
@@ -85,14 +96,12 @@ def _login_old(self, username, password, method, path):
                 )
             )
 
-    def _login_latestv1(self, username, password, method, path):
+    def _login_latestv1(self, username, password, login_domain, method, path):
         """Nexus Dashboard NDFC Helper Function to login to NDFC version 12 or later."""
-        login_domain = "DefaultAuth"
-        # login_domain = 'local'
         payload = {
-            "username": self.connection.get_option("remote_user"),
-            "password": self.connection.get_option("password"),
-            "domain": login_domain,
+            "username": username,
+            "password": password,
+            "domain": login_domain
         }
         data = json.dumps(payload)
         try:
@@ -123,14 +132,12 @@ def _login_latestv1(self, username, password, method, path):
                 )
             )
 
-    def _login_latestv2(self, username, password, method, path):
+    def _login_latestv2(self, username, password, login_domain, method, path):
         """Nexus Dashboard NDFC Helper Function to login to NDFC version 12 or later."""
-        login_domain = "DefaultAuth"
-        # login_domain = 'local'
         payload = {
-            "userName": self.connection.get_option("remote_user"),
-            "userPasswd": self.connection.get_option("password"),
-            "domain": login_domain,
+            "userName": username,
+            "userPasswd": password,
+            "domain": login_domain
         }
         data = json.dumps(payload)
         try:
@@ -168,6 +175,7 @@ def login(self, username, password):
         """
         self.login_succeeded = False
         self.login_fail_msg = []
+        login_domain = "local"  # default login domain of Nexus Dashboard
         method = "POST"
         path = {"dcnm": "/rest/logon", "ndfc": "/login"}
         login12Func = [self._login_latestv2, self._login_latestv1]
@@ -176,9 +184,11 @@ def login(self, username, password):
         self._login_old(username, password, method, path["dcnm"])
 
         # If login attempt failed then try NDFC version 12
+        if self.get_option("login_domain") is not None:
+            login_domain = self.get_option("login_domain")
         if not self.login_succeeded:
             for func in login12Func:
-                func(username, password, method, path["ndfc"])
+                func(username, password, login_domain, method, path["ndfc"])
                 if self.login_succeeded:
                     break