fix netconf_get documentation section and lock logic (#40357)

* fix netconf_get documentation section and lock logic

* updated lock behavior

lib/ansible/modules/network/netconf/netconf_get.py

@@ -51,15 +51,13 @@ options:
     choices: ['json', 'pretty', 'xml']
   lock:
     description:
-      - Instructs the module to explicitly lock the datastore specified as C(source) before fetching
+      - Instructs the module to explicitly lock the datastore specified as C(source). If no
-        configuration and/or state information from remote host. If the value is I(never) in that case
+        I(source) is defined, the I(running) datastore will be locked. By setting the option
-        the C(source) datastore is never locked, if the value is I(if-supported) the C(source) datastore
+        value I(always) is will explicitly lock the datastore mentioned in C(source) option.
-        is locked only if the Netconf server running on remote host supports locking of that datastore,
+        By setting the option value I(never) it will not lock the C(source) datastore. The
-        if the lock on C(source) datastore is not supported module will report appropriate error before
+        value I(if-supported) allows better interworking with NETCONF servers, which do not
-        executing lock. If the value is I(always) the lock operation on C(source) datastore will always
+        support the (un)lock operation for all supported datastores.
-        be executed irrespective if the remote host supports it or not, if it doesn't the module with
+    default: never
-        fail will the execption message received from remote host and might vary based on the platform.
-    default: 'never'
     choices: ['never', 'always', 'if-supported']
 requirements:
   - ncclient (>=v0.5.2)
@@ -90,26 +88,33 @@ EXAMPLES = """
 
 - name: get schema list using subtree w/ namespaces
   netconf_get:
-    format: json
+    display: json
     filter: <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"><schemas><schema/></schemas></netconf-state>
-    lock: False
+    lock: never
 
 - name: get schema list using xpath
   netconf_get:
-    format: json
+    display: xml
     filter: /netconf-state/schemas/schema
 
 - name: get interface confiugration with filter (iosxr)
   netconf_get:
+    display: pretty
     filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
+    lock: if-supported
 
-- name: Get system configuration data from running datastore state (sros)
+- name: Get system configuration data from running datastore state (junos)
   netconf_get:
     source: running
-    filter: <state xmlns="urn:nokia.com:sros:ns:yang:sr:conf"/>
+    filter: <configuration><system></system></configuration>
-    lock: True
+    lock: if-supported
 
-- name: Get state data (sros)
+- name: Get complete configuration data from running datastore (SROS)
+  netconf_get:
+    source: running
+    filter: <configure xmlns="urn:nokia.com:sros:ns:yang:sr:conf"/>
+
+- name: Get complete state data (SROS)
   netconf_get:
     filter: <state xmlns="urn:nokia.com:sros:ns:yang:sr:state"/>
 """
@@ -203,28 +208,19 @@ def main():
     if filter_type == 'xpath' and not operations.get('supports_xpath', False):
         module.fail_json(msg="filter value '%s' of type xpath is not supported on this device" % filter)
 
-    execute_lock = True if lock in ('always', 'if-supported') else False
+    # If source is None, NETCONF <get> operation is issued, reading config/state data
+    # from the running datastore. The python expression "(source or 'running')" results
+    # in the value of source (if not None) or the value 'running' (if source is None).
 
-    if lock == 'always' and not operations.get('supports_lock', False):
+    if lock == 'never':
-        module.fail_json(msg='lock operation is not supported on this device')
+        execute_lock = False
-
+    elif (source or 'running') in operations.get('lock_datastore', []):
-    if execute_lock:
+        # lock is requested (always/if-support) and supported => lets do it
-        if source is None:
+        execute_lock = True
-            # if source is None, in that case operation is 'get' and `get` supports
+    else:
-            # fetching data only from running datastore
+        # lock is requested (always/if-supported) but not supported => issue warning
-            if 'running' not in operations.get('lock_datastore', []):
+        module.warn("lock operation on '%s' source is not supported on this device" % (source or 'running'))
-                # lock is not supported, don't execute lock operation
+        execute_lock = (lock == 'always')
-                if lock == 'if-supported':
-                    execute_lock = False
-                else:
-                    module.warn("lock operation on 'running' source is not supported on this device")
-        else:
-            if source not in operations.get('lock_datastore', []):
-                if lock == 'if-supported':
-                    # lock is not supported, don't execute lock operation
-                    execute_lock = False
-                else:
-                    module.warn("lock operation on '%s' source is not supported on this device" % source)
 
     if display == 'json' and not HAS_JXMLEASE:
         module.fail_json(msg='jxmlease is required to display response in json format'