Remove xml return for junos declarative modules (#26400)

*  Remove xml return
*  Add diff return
*  Related doc changes

lib/ansible/modules/network/interface/net_interface.py

@@ -107,22 +107,9 @@ EXAMPLES = """
 RETURN = """
 commands:
   description: The list of configuration mode commands to send to the device.
-  returned: always
+  returned: always, except for the platforms that use Netconf transport to manage the device.
   type: list
   sample:
     - interface 20
     - name test-interface
-
-rpc:
-  description: load-configuration RPC send to the device
-  returned: C(rpc) is returned only for junos device
-            when configuration is changed on device
-  type: string
-  sample: >
-            <interfaces>
-                <interface>
-                    <name>ge-0/0/0</name>
-                    <description>test interface</description>
-                </interface>
-            </interfaces>
 """

lib/ansible/modules/network/interface/net_linkagg.py

@@ -82,7 +82,7 @@ EXAMPLES = """
 RETURN = """
 commands:
   description: The list of configuration mode commands to send to the device
-  returned: always
+  returned: always, except for the platforms that use Netconf transport to manage the device.
   type: list
   sample:
     - set interfaces bonding bond0

lib/ansible/modules/network/junos/junos_banner.py

@@ -101,16 +101,13 @@ EXAMPLES = """
 """
 
 RETURN = """
-rpc:
+diff:
-  description: load-configuration RPC send to the device
+  description: Configuration difference before and after applying change.
-  returned: when configuration is changed on device
+  returned: when configuration is changed.
   type: string
   sample: >
-          <system>
+          [edit system login]
-            <login>
+          +   message \"this is my login banner\";
-                <message>this is my login banner</message>
-            </login>
-          </system>"
 """
 import collections
 
@@ -182,8 +179,7 @@ def main():
     if diff:
         result.update({
             'changed': True,
-            'diff': {'prepared': diff},
+            'diff': diff,
-            'rpc': tostring(ele)
         })
 
     module.exit_json(**result)

lib/ansible/modules/network/junos/junos_interface.py

@@ -129,17 +129,15 @@ EXAMPLES = """
 """
 
 RETURN = """
-rpc:
+diff:
-  description: load-configuration RPC send to the device
+  description: Configuration difference before and after applying change.
-  returned: when configuration is changed on device
+  returned: when configuration is changed.
   type: string
   sample: >
-            <interfaces>
+        [edit interfaces]
-                <interface>
+        +   ge-0/0/1 {
-                    <name>ge-0/0/0</name>
+        +       description test-interface;
-                    <description>test interface</description>
+        +   }
-                </interface>
-            </interfaces>
 """
 import collections
 
@@ -240,8 +238,7 @@ def main():
     if diff:
         result.update({
             'changed': True,
-            'diff': {'prepared': diff},
+            'diff': diff,
-            'rpc': tostring(ele)
         })
 
     module.exit_json(**result)

lib/ansible/modules/network/junos/junos_logging.py

@@ -111,18 +111,17 @@ EXAMPLES = """
 """
 
 RETURN = """
-rpc:
+diff:
-  description: load-configuration RPC send to the device
+  description: Configuration difference before and after applying change.
-  returned: when configuration is changed on device
+  returned: when configuration is changed.
   type: string
   sample: >
-         <system>
+          [edit system syslog]
-            <syslog>
+          +    [edit system syslog]
-                <console replace=\"replace\" active=\"active\">
+               file interactive-commands { ... }
-                    <name>pfe</name><error/>
+          +    file test {
-                </console>
+          +        pfe critical;
-            </syslog>
+          +    }
-         </system>
 """
 import collections
 
@@ -186,11 +185,8 @@ def main():
                    ('dest', 'user', ['name', 'facility', 'level']),
                    ('dest', 'console', ['facility', 'level'])]
 
-    mutually_exclusive = [('console', 'name')]
-
     module = AnsibleModule(argument_spec=argument_spec,
                            required_if=required_if,
-                           mutually_exclusive=mutually_exclusive,
                            supports_check_mode=True)
 
     warnings = list()
@@ -240,8 +236,7 @@ def main():
     if diff:
         result.update({
             'changed': True,
-            'diff': {'prepared': diff},
+            'diff': diff,
-            'rpc': tostring(ele)
         })
 
     module.exit_json(**result)

lib/ansible/modules/network/junos/junos_system.py

@@ -100,17 +100,18 @@ EXAMPLES = """
 """
 
 RETURN = """
-rpc:
+diff:
-  description: load-configuration RPC send to the device
+  description: Configuration difference before and after applying change.
-  returned: when configuration is changed on device
+  returned: when configuration is changed.
   type: string
   sample: >
-            <interfaces>
+          [edit system]
-                <interface>
+          +  host-name test;
-                    <name>ge-0/0/0</name>
+          +  domain-name ansible.com;
-                    <description>test interface</description>
+          +  domain-search redhat.com;
-                </interface>
+          [edit system name-server]
-            </interfaces>
+              172.26.1.1 { ... }
+          +   8.8.8.8;
 """
 import collections
 
@@ -190,8 +191,7 @@ def main():
     if diff:
         result.update({
             'changed': True,
-            'diff': {'prepared': diff},
+            'diff': diff,
-            'rpc': tostring(ele)
         })
 
     module.exit_json(**result)

lib/ansible/modules/network/junos/junos_user.py

@@ -118,6 +118,16 @@ EXAMPLES = """
 """
 
 RETURN = """
+diff:
+  description: Configuration difference before and after applying change.
+  returned: when configuration is changed.
+  type: string
+  sample: >
+          [edit system login]
+          +    user test-user {
+          +        uid 2005;
+          +        class read-only;
+          +    }
 """
 from functools import partial
 
@@ -265,7 +275,7 @@ def main():
     if diff:
         result.update({
             'changed': True,
-            'diff': {'prepared': diff}
+            'diff': diff
         })
 
     module.exit_json(**result)

lib/ansible/modules/network/junos/junos_vlan.py

@@ -98,11 +98,15 @@ EXAMPLES = """
 """
 
 RETURN = """
-rpc:
+diff:
-  description: load-configuration RPC send to the device
+  description: Configuration difference before and after applying change.
-  returned: when configuration is changed on device
+  returned: when configuration is changed.
   type: string
-  sample: "<vlans><vlan><name>test-vlan-4</name></vlan></vlans>"
+  sample: >
+         [edit vlans]
+         +   test-vlan-1 {
+         +       vlan-id 60;
+         +   }
 """
 import collections
 
@@ -181,8 +185,7 @@ def main():
     if diff:
         result.update({
             'changed': True,
-            'diff': {'prepared': diff},
+            'diff': diff,
-            'rpc': tostring(ele)
         })
 
     module.exit_json(**result)

lib/ansible/modules/network/layer2/net_vlan.py

@@ -76,16 +76,9 @@ EXAMPLES = """
 RETURN = """
 commands:
   description: The list of configuration mode commands to send to the device
-  returned: always
+  returned: always, except for the platforms that use Netconf transport to manage the device.
   type: list
   sample:
     - vlan 20
     - name test-vlan
-
-rpc:
-  description: load-configuration RPC send to the device
-  returned: C(rpc) is returned only for junos device
-            when configuration is changed on device
-  type: string
-  sample: "<vlans><vlan><name>test-vlan-4</name></vlan></vlans>"
 """

lib/ansible/modules/network/layer3/net_vrf.py

@@ -67,7 +67,7 @@ EXAMPLES = """
 RETURN = """
 commands:
   description: The list of configuration mode commands to send to the device
-  returned: always
+  returned: always, except for the platforms that use Netconf transport to manage the device.
   type: list
   sample:
     - vrf definition MANAGEMENT

lib/ansible/modules/network/system/net_banner.py

@@ -78,22 +78,11 @@ EXAMPLES = """
 RETURN = """
 commands:
   description: The list of configuration mode commands to send to the device
-  returned: always
+  returned: always, except for the platforms that use Netconf transport to manage the device.
   type: list
   sample:
     - banner login
     - this is my login banner
     - that contains a multiline
     - string
-
-rpc:
-  description: load-configuration RPC send to the device
-  returned: when configuration is changed on device
-  type: string
-  sample: >
-          <system>
-            <login>
-                <message>this is my login banner</message>
-            </login>
-          </system>"
 """

lib/ansible/modules/network/system/net_logging.py

@@ -84,22 +84,8 @@ EXAMPLES = """
 RETURN = """
 commands:
   description: The list of configuration mode commands to send to the device
-  returned: always
+  returned: always, except for the platforms that use Netconf transport to manage the device.
   type: list
   sample:
     - logging console critical
-
-rpc:
-  description: load-configuration RPC send to the device
-  returned: C(rpc) is returned only for junos device
-            when configuration is changed on device
-  type: string
-  sample: >
-         <system>
-            <syslog>
-                <console replace=\"replace\" active=\"active\">
-                    <name>pfe</name><error/>
-                </console>
-            </syslog>
-         </system>
 """

lib/ansible/modules/network/system/net_system.py

@@ -102,22 +102,9 @@ EXAMPLES = """
 RETURN = """
 commands:
   description: The list of configuration mode commands to send to the device
-  returned: always
+  returned: always, except for the platforms that use Netconf transport to manage the device.
   type: list
   sample:
     - hostname ios01
     - ip domain name test.example.com
-
-rpc:
-  description: load-configuration RPC send to the device
-  returned: C(rpc) is returned only for junos device
-            when configuration is changed on device
-  type: string
-  sample: >
-            <interfaces>
-                <interface>
-                    <name>ge-0/0/0</name>
-                    <description>test interface</description>
-                </interface>
-            </interfaces>
 """