Fix YAML syntax in NXOS documentation (#4922)

* Fix YAML syntax in NXOS documentation

Use ':' and not '=' to ensure valid YAML
in the EXAMPLES

* Correcting introduced syntax error

network/nxos/nxos_aaa_server.py

@@ -86,33 +86,33 @@ EXAMPLES = '''
 # Radius Server Basic settings
   - name: "Radius Server Basic settings"
     nxos_aaa_server:
-        server_type=radius
+        server_type: radius
-        server_timeout=9
+        server_timeout: 9
-        deadtime=20
+        deadtime: 20
-        directed_request=enabled
+        directed_request: enabled
-        host={{ inventory_hostname }}
+        host:  inventory_hostname }}
-        username={{ un }}
+        username:  un }}
-        password={{ pwd }}
+        password:  pwd }}
 
 # Tacacs Server Basic settings
   - name: "Tacacs Server Basic settings"
     nxos_aaa_server:
-        server_type=tacacs
+        server_type: tacacs
-        server_timeout=8
+        server_timeout: 8
-        deadtime=19
+        deadtime: 19
-        directed_request=disabled
+        directed_request: disabled
-        host={{ inventory_hostname }}
+        host:  inventory_hostname }}
-        username={{ un }}
+        username:  un }}
-        password={{ pwd }}
+        password:  pwd }}
 
 # Setting Global Key
   - name: "AAA Server Global Key"
     nxos_aaa_server:
-        server_type=radius
+        server_type: radius
-        global_key=test_key
+        global_key: test_key
-        host={{ inventory_hostname }}
+        host:  inventory_hostname }}
-        username={{ un }}
+        username:  un }}
-        password={{ pwd }}
+        password:  pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_aaa_server_host.py

@@ -83,38 +83,38 @@ EXAMPLES = '''
 # Radius Server Host Basic settings
   - name: "Radius Server Host Basic settings"
     nxos_aaa_server_host:
-        state=present
+        state: present
-        server_type=radius
+        server_type: radius
-        address=1.2.3.4
+        address: 1.2.3.4
-        acct_port=2084
+        acct_port: 2084
-        host_timeout=10
+        host_timeout: 10
-        host={{ inventory_hostname }}
+        host: {{ inventory_hostname }}
-        username={{ un }}
+        username: {{ un }}
-        password={{ pwd }}
+        password: {{ pwd }}
 
 # Radius Server Host Key Configuration
   - name: "Radius Server Host Key Configuration"
     nxos_aaa_server_host:
-        state=present
+        state: present
-        server_type=radius
+        server_type: radius
-        address=1.2.3.4
+        address: 1.2.3.4
-        key=hello
+        key: hello
-        encrypt_type=7
+        encrypt_type: 7
-        host={{ inventory_hostname }}
+        host:  inventory_hostname }}
-        username={{ un }}
+        username: {{ un }}
-        password={{ pwd }}
+        password: {{ pwd }}
 
 # TACACS Server Host Configuration
   - name: "Tacacs Server Host Configuration"
     nxos_aaa_server_host:
-        state=present
+        state: present
-        server_type=tacacs 
+        server_type: tacacs 
-        tacacs_port=89
+        tacacs_port: 89
-        host_timeout=10
+        host_timeout: 10
-        address=5.6.7.8
+        address: 5.6.7.8
-        host={{ inventory_hostname }}
+        host:  inventory_hostname }}
-        username={{ un }}
+        username:  un }}
-        password={{ pwd }}
+        password:  pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_bgp.py

@@ -288,10 +288,10 @@ options:
 EXAMPLES = '''
 # configure a simple asn
 - nxos_bgp:
-      asn=65535
+      asn: 65535
-      vrf=test
+      vrf: test
-      router_id=1.1.1.1
+      router_id: 1.1.1.1
-      state=present
+      state: present
       username: "{{ un }}"
       password: "{{ pwd }}"
       host: "{{ inventory_hostname }}"

network/nxos/nxos_bgp_af.py

@@ -242,12 +242,12 @@ options:
 EXAMPLES = '''
 # configure a simple address-family
 - nxos_bgp_af:
-    asn=65535
+    asn: 65535
-    vrf=TESTING
+    vrf: TESTING
-    afi=ipv4
+    afi: ipv4
-    safi=unicast
+    safi: unicast
-    advertise_l2vpn_evpn=true
+    advertise_l2vpn_evpn: true
-    state=present
+    state: present
 '''
 
 RETURN = '''

network/nxos/nxos_evpn_global.py

@@ -34,7 +34,7 @@ options:
 '''
 EXAMPLES = '''
 - nxos_evpn_global:
-    nv_overlay_evpn=true
+    nv_overlay_evpn: true
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_igmp_snooping.py

@@ -72,10 +72,10 @@ options:
 EXAMPLES = '''
 # ensure igmp snooping params supported in this module are in there default state
 - nxos_igmp_snooping:
-    state=default
+    state: default
-    host={{ inventory_hostname }}
+    host:  inventory_hostname }}
-    username={{ un }}
+    username:  un }}
-    password={{ pwd }}
+    password:  pwd }}
 
 # ensure following igmp snooping params are in the desired state
 - nxos_igmp_snooping:
@@ -86,8 +86,8 @@ EXAMPLES = '''
    report_supp: true
    v3_report_supp: true
    host: "{{ inventory_hostname }}"
-   username={{ un }}
+   username: {{ un }}
-   password={{ pwd }}
+   password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_interface_ospf.py

@@ -115,9 +115,9 @@ options:
 '''
 EXAMPLES = '''
 - nxos_interface_ospf:
-    interface=ethernet1/32
+    interface: ethernet1/32
-    ospf=1
+    ospf: 1
-    area=1
+    area: 1
     cost=default
     username: "{{ un }}"
     password: "{{ pwd }}"

network/nxos/nxos_mtu.py

@@ -56,34 +56,35 @@ options:
 EXAMPLES = '''
 # Ensure system mtu is 9126
 - nxos_mtu:
-    sysmtu=9216
+    sysmtu: 9216
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # Config mtu on Eth1/1 (routed interface)
 - nxos_mtu:
-    interface=Ethernet1/1
+    interface: Ethernet1/1
-    mtu=1600
+    mtu: 1600
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # Config mtu on Eth1/3 (switched interface)
 - nxos_mtu:
-    interface=Ethernet1/3
+    interface: Ethernet1/3
-    mtu=9216
+    mtu: 9216
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # Unconfigure mtu on a given interface
 - nxos_mtu:
-    interface=Ethernet1/3
+    interface: Ethernet1/3
-    mtu=9216 host={{ inventory_hostname }}
+    mtu: 9216
-    username={{ un }}
+    host: {{ inventory_hostname }}
-    password={{ pwd }}
+    username: {{ un }}
-    state=absent
+    password: {{ pwd }}
+    state: absent
 '''
 
 RETURN = '''

network/nxos/nxos_ntp.py

@@ -78,12 +78,12 @@ options:
 EXAMPLES = '''
 # Set NTP Server with parameters
 - nxos_ntp:
-    server=1.2.3.4
+    server: 1.2.3.4
-    key_id=32
+    key_id: 32
-    prefer=enabled
+    prefer: enabled
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_ntp_auth.py

@@ -74,12 +74,12 @@ options:
 EXAMPLES = '''
 # Basic NTP authentication configuration
 - nxos_ntp_auth:
-    key_id=32
+    key_id: 32
-    md5string=hello
+    md5string: hello
-    auth_type=text
+    auth_type: text
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_ntp_options.py

@@ -63,12 +63,12 @@ options:
 EXAMPLES = '''
 # Basic NTP options configuration
 - nxos_ntp_options:
-    master=true
+    master: true
-    stratum=12
+    stratum: 12
-    logging=false
+    logging: false
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_ospf.py

@@ -41,7 +41,7 @@ options:
 
 EXAMPLES = '''
 - nxos_ospf:
-    ospf=1
+    ospf: 1
     state: present
     username: "{{ un }}"
     password: "{{ pwd }}"

network/nxos/nxos_overlay_global.py

@@ -39,7 +39,7 @@ options:
 
 EXAMPLES = '''
 - nxos_overlay_global:
-    anycast_gateway_mac="b.b.b"
+    anycast_gateway_mac: "b.b.b"
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_pim.py

@@ -34,7 +34,7 @@ options:
 '''
 EXAMPLES = '''
 - nxos_pim:
-    ssm_range="232.0.0.0/8"
+    ssm_range: "232.0.0.0/8"
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_pim_interface.py

@@ -108,40 +108,40 @@ options:
 EXAMPLES = '''
 # ensure PIM is not running on the interface
 - nxos_pim_interface:
-    interface=eth1/33
+    interface: eth1/33
-    state=absent
+    state: absent
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # ensure the interface has pim-sm enabled with the appropriate priority and hello interval
 - nxos_pim_interface:
-    interface=eth1/33
+    interface: eth1/33
-    dr_prio=10
+    dr_prio: 10
-    hello_interval=40
+    hello_interval: 40
-    state=present
+    state: present
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # ensure join-prune policies exist
 - nxos_pim_interface:
-    interface=eth1/33
+    interface: eth1/33
-    jp_policy_in=JPIN
+    jp_policy_in: JPIN
-    jp_policy_out=JPOUT
+    jp_policy_out: JPOUT
-    jp_type_in=routemap
+    jp_type_in: routemap
-    jp_type_out=routemap
+    jp_type_out: routemap
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # ensure defaults are in place
 - nxos_pim_interface:
-    interface=eth1/33
+    interface: eth1/33
-    state=default
+    state: default
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_snmp_community.py

@@ -59,12 +59,12 @@ options:
 EXAMPLES = '''
 # ensure snmp community is configured
 - nxos_snmp_community:
-    community=TESTING7
+    community: TESTING7
-    group=network-operator
+    group: network-operator
-    state=present
+    state: present
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_snmp_contact.py

@@ -45,11 +45,11 @@ options:
 EXAMPLES = '''
 # ensure snmp contact is configured
 - nxos_snmp_contact:
-    contact=Test
+    contact: Test
-    state=present
+    state: present
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_snmp_host.py

@@ -84,12 +84,12 @@ options:
 EXAMPLES = '''
 # ensure snmp host is configured
 - nxos_snmp_host:
-    snmp_host=3.3.3.3
+    snmp_host: 3.3.3.3
-    community=TESTING
+    community: TESTING
-    state=present
+    state: present
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_snmp_location.py

@@ -44,19 +44,19 @@ options:
 EXAMPLES = '''
 # ensure snmp location is configured
 - nxos_snmp_location:
-    location=Test
+    location: Test
-    state=present
+    state: present
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # ensure snmp location is not configured
 - nxos_snmp_location:
-    location=Test
+    location: Test
-    state=absent
+    state: absent
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_snmp_traps.py

@@ -49,22 +49,22 @@ options:
         choices: ['enabled','disabled']
 '''
 
-EXAMPLES = '''
+EXAMPLES =  '''
 # ensure lldp trap configured
 - nxos_snmp_traps:
-    group=lldp
+    group: lldp
-    state=enabled
+    state: enabled
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # ensure lldp trap is not configured
 - nxos_snmp_traps:
-    group=lldp
+    group: lldp
-    state=disabled
+    state: disabled
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_snmp_user.py

@@ -69,13 +69,13 @@ options:
 
 EXAMPLES = '''
 - nxos_snmp_user:
-    user=ntc
+    user: ntc
-    group=network-operator
+    group: network-operator
-    auth=md5
+    auth: md5
-    pwd=test_password
+    pwd: test_password
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_static_route.py

@@ -67,10 +67,10 @@ options:
 
 EXAMPLES = '''
 - nxos_static_route:
-    prefix="192.168.20.64/24"
+    prefix: "192.168.20.64/24"
-    next_hop="3.3.3.3"
+    next_hop: "3.3.3.3"
-    route_name=testing
+    route_name: testing
-    pref=100
+    pref: 100
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_udld.py

@@ -60,19 +60,19 @@ options:
 EXAMPLES = '''
 # ensure udld aggressive mode is globally disabled and se global message interval is 20
 - nxos_udld:
-    aggressive=disabled
+    aggressive: disabled
-    msg_time=20
+    msg_time: 20
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # Ensure agg mode is globally enabled and msg time is 15
 - nxos_udld:
-    aggressive=enabled
+    aggressive: enabled
-    msg_time=15
+    msg_time: 15
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_udld_interface.py

@@ -48,29 +48,29 @@ options:
 EXAMPLES = '''
 # ensure Ethernet1/1 is configured to be in aggressive mode
 - nxos_udld_interface:
-    interface=Ethernet1/1
+    interface: Ethernet1/1
-    mode=aggressive
+    mode: aggressive
-    state=present
+    state: present
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default)
 - nxos_udld_interface:
-    interface=Ethernet1/1
+    interface: Ethernet1/1
-    mode=aggressive
+    mode: aggressive
-    state=absent
+    state: absent
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # ensure Ethernet1/1 has aggressive mode enabled
 - nxos_udld_interface:
-    interface=Ethernet1/1
+    interface: Ethernet1/1
-    mode=enabled
+    mode: enabled
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_vpc.py

@@ -90,13 +90,13 @@ options:
 EXAMPLES = '''
 # configure a simple asn
 - nxos_vpc:
-    domain=100
+    domain: 100
-    role_priority=1000
+    role_priority: 1000
-    system_priority=2000
+    system_priority: 2000
-    pkl_dest=192.168.100.4
+    pkl_dest: 192.168.100.4
-    pkl_src=10.1.100.20
+    pkl_src: 10.1.100.20
-    peer_gw=true
+    peer_gw: true
-    auto_recovery=true
+    auto_recovery: true
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_vpc_interface.py

@@ -58,8 +58,8 @@ options:
 
 EXAMPLES = '''
 - nxos_vpc_portchannel:
-    portchannel=10
+    portchannel: 10
-    vpc=100
+    vpc: 100
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_vrf_af.py

@@ -61,9 +61,9 @@ options:
 '''
 EXAMPLES = '''
 - nxos_vrf_af:
-    interface=nve1
+    interface: nve1
-    vni=6000
+    vni: 6000
-    ingress_replication=true
+    ingress_replication: true
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_vtp_domain.py

@@ -44,10 +44,10 @@ options:
 EXAMPLES = '''
 # ENSURE VTP DOMAIN IS CONFIGURED
 - nxos_vtp_domain:
-    domain=ntc
+    domain: ntc
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 

network/nxos/nxos_vtp_password.py

@@ -54,19 +54,19 @@ options:
 EXAMPLES = '''
 # ENSURE VTP PASSWORD IS SET
 - nxos_vtp_password:
-    password=ntc
+    password: ntc
-    state=present
+    state: present
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 
 # ENSURE VTP PASSWORD IS REMOVED
 - nxos_vtp_password:
-    password=ntc
+    password: ntc
-    state=absent
+    state: absent
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_vtp_version.py

@@ -42,10 +42,10 @@ options:
 EXAMPLES = '''
 # ENSURE VTP VERSION IS 2
 - nxos_vtp_version:
-    version=2
+    version: 2
-    host={{ inventory_hostname }}
+    host: {{ inventory_hostname }}
-    username={{ un }}
+    username: {{ un }}
-    password={{ pwd }}
+    password: {{ pwd }}
 '''
 
 RETURN = '''

network/nxos/nxos_vxlan_vtep.py

@@ -75,12 +75,12 @@ options:
 '''
 EXAMPLES = '''
 - nxos_vxlan_vtep:
-    interface=nve1
+    interface: nve1
-    description=default
+    description: default
-    host_reachability=default
+    host_reachability: default
-    source_interface=Loopback0
+    source_interface: Loopback0
-    source_interface_hold_down_time=30
+    source_interface_hold_down_time: 30
-    shutdown=default
+    shutdown: default
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"

network/nxos/nxos_vxlan_vtep_vni.py

@@ -101,9 +101,9 @@ options:
 '''
 EXAMPLES = '''
 - nxos_vxlan_vtep_vni:
-    interface=nve1
+    interface: nve1
-    vni=6000
+    vni: 6000
-    ingress_replication=default
+    ingress_replication: default
     username: "{{ un }}"
     password: "{{ pwd }}"
     host: "{{ inventory_hostname }}"