archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix YAML syntax in NXOS documentation (#4922)

Browse Source 
* Fix YAML syntax in NXOS documentation

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

* Correcting introduced syntax error
pull/18777/head
Josh Lothian 8 years ago committed by Matt Clay
parent 10af591da2
commit 319b2b28cb
32 changed files with 263 additions and 258 deletions
Show Stats Download Patch File Download Diff File

38
lib/ansible/modules/network/nxos/nxos_aaa_server.py
Unescape Escape View File

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

48
lib/ansible/modules/network/nxos/nxos_aaa_server_host.py
Unescape Escape View File

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

7
lib/ansible/modules/network/nxos/nxos_bgp.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_bgp_af.py
Unescape Escape View File

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

5
lib/ansible/modules/network/nxos/nxos_evpn_global.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_igmp_snooping.py
Unescape Escape View File

@ -72,10 +72,10 @@ options:
EXAMPLES = '''
# ensure igmp snooping params supported in this module are in there default state
- nxos_igmp_snooping:
state=default
host={{ inventory_hostname }}
username={{ un }}
password={{ pwd }}
state: default
host: inventory_hostname }}
username: un }}
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 }}
password={{ pwd }}
username: {{ un }}
password: {{ pwd }}
'''
RETURN = '''

6
lib/ansible/modules/network/nxos/nxos_interface_ospf.py
Unescape Escape View File

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

39
lib/ansible/modules/network/nxos/nxos_mtu.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_ntp.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_ntp_auth.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_ntp_options.py
Unescape Escape View File

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

2
lib/ansible/modules/network/nxos/nxos_ospf.py
Unescape Escape View File

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

2
lib/ansible/modules/network/nxos/nxos_overlay_global.py
Unescape Escape View File

@ -44,7 +44,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 }}"

2
lib/ansible/modules/network/nxos/nxos_pim.py
Unescape Escape View File

@ -40,7 +40,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 }}"

50
lib/ansible/modules/network/nxos/nxos_pim_interface.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_snmp_community.py
Unescape Escape View File

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

10
lib/ansible/modules/network/nxos/nxos_snmp_contact.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_snmp_host.py
Unescape Escape View File

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

20
lib/ansible/modules/network/nxos/nxos_snmp_location.py
Unescape Escape View File

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

20
lib/ansible/modules/network/nxos/nxos_snmp_traps.py
Unescape Escape View File

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

14
lib/ansible/modules/network/nxos/nxos_snmp_user.py
Unescape Escape View File

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

8
lib/ansible/modules/network/nxos/nxos_static_route.py
Unescape Escape View File

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

20
lib/ansible/modules/network/nxos/nxos_udld.py
Unescape Escape View File

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

34
lib/ansible/modules/network/nxos/nxos_udld_interface.py
Unescape Escape View File

@ -48,29 +48,29 @@ options:
EXAMPLES = '''
# ensure Ethernet1/1 is configured to be in aggressive mode
- nxos_udld_interface:
interface=Ethernet1/1
mode=aggressive
state=present
host={{ inventory_hostname }}
username={{ un }}
password={{ pwd }}
interface: Ethernet1/1
mode: aggressive
state: present
host: {{ inventory_hostname }}
username: {{ un }}
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
mode=aggressive
state=absent
host={{ inventory_hostname }}
username={{ un }}
password={{ pwd }}
interface: Ethernet1/1
mode: aggressive
state: absent
host: {{ inventory_hostname }}
username: {{ un }}
password: {{ pwd }}
# ensure Ethernet1/1 has aggressive mode enabled
- nxos_udld_interface:
interface=Ethernet1/1
mode=enabled
host={{ inventory_hostname }}
username={{ un }}
password={{ pwd }}
interface: Ethernet1/1
mode: enabled
host: {{ inventory_hostname }}
username: {{ un }}
password: {{ pwd }}
'''
RETURN = '''

14
lib/ansible/modules/network/nxos/nxos_vpc.py
Unescape Escape View File

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

4
lib/ansible/modules/network/nxos/nxos_vpc_interface.py
Unescape Escape View File

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

6
lib/ansible/modules/network/nxos/nxos_vrf_af.py
Unescape Escape View File

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

8
lib/ansible/modules/network/nxos/nxos_vtp_domain.py
Unescape Escape View File

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

20
lib/ansible/modules/network/nxos/nxos_vtp_password.py
Unescape Escape View File

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

8
lib/ansible/modules/network/nxos/nxos_vtp_version.py
Unescape Escape View File

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

12
lib/ansible/modules/network/nxos/nxos_vxlan_vtep.py
Unescape Escape View File

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

6
lib/ansible/modules/network/nxos/nxos_vxlan_vtep_vni.py
Unescape Escape View File

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

Write Preview
Loading…
Cancel
Save