From 507559dba5338f531ac976db95d876b3686d0886 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Moser?= Date: Thu, 1 Dec 2016 11:48:40 +0100 Subject: [PATCH] doc: network: fix syntax errors in examples (#5780) --- lib/ansible/modules/network/eos/eos_eapi.py | 6 ++--- .../network/nxos/nxos_aaa_server_host.py | 10 ++++---- .../network/nxos/nxos_igmp_snooping.py | 4 ++-- lib/ansible/modules/network/nxos/nxos_mtu.py | 24 +++++++++---------- lib/ansible/modules/network/nxos/nxos_ntp.py | 6 ++--- .../modules/network/nxos/nxos_ntp_auth.py | 6 ++--- .../modules/network/nxos/nxos_ntp_options.py | 6 ++--- .../modules/network/nxos/nxos_nxapi.py | 6 ++--- .../network/nxos/nxos_pim_interface.py | 24 +++++++++---------- .../network/nxos/nxos_snmp_community.py | 6 ++--- .../modules/network/nxos/nxos_snmp_contact.py | 6 ++--- .../modules/network/nxos/nxos_snmp_host.py | 6 ++--- .../network/nxos/nxos_snmp_location.py | 12 +++++----- .../modules/network/nxos/nxos_snmp_traps.py | 12 +++++----- .../modules/network/nxos/nxos_snmp_user.py | 6 ++--- lib/ansible/modules/network/nxos/nxos_udld.py | 12 +++++----- .../network/nxos/nxos_udld_interface.py | 18 +++++++------- .../modules/network/nxos/nxos_vtp_domain.py | 6 ++--- .../modules/network/nxos/nxos_vtp_password.py | 12 +++++----- .../modules/network/nxos/nxos_vtp_version.py | 6 ++--- .../modules/network/sros/sros_config.py | 2 +- 21 files changed, 98 insertions(+), 98 deletions(-) diff --git a/lib/ansible/modules/network/eos/eos_eapi.py b/lib/ansible/modules/network/eos/eos_eapi.py index 8087a8d0da..96ad4ee576 100644 --- a/lib/ansible/modules/network/eos/eos_eapi.py +++ b/lib/ansible/modules/network/eos/eos_eapi.py @@ -148,7 +148,7 @@ vars: - name: Enable eAPI access with default configuration eos_eapi: state: started - provider: {{ cli }} + provider: "{{ cli }}" - name: Enable eAPI with no HTTP, HTTPS at port 9443, local HTTP at port 80, and socket enabled eos_eapi: @@ -158,12 +158,12 @@ vars: local_http: yes local_http_port: 80 socket: yes - provider: {{ cli }} + provider: "{{ cli }}" - name: Shutdown eAPI access eos_eapi: state: stopped - provider: {{ cli }} + provider: "{{ cli }}" """ RETURN = """ diff --git a/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py b/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py index 28f24f86ad..9cfcd004bb 100644 --- a/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py +++ b/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py @@ -88,9 +88,9 @@ EXAMPLES = ''' address: 1.2.3.4 acct_port: 2084 host_timeout: 10 - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" # Radius Server Host Key Configuration - name: "Radius Server Host Key Configuration" @@ -101,8 +101,8 @@ EXAMPLES = ''' key: hello encrypt_type: 7 host: inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + username: "{{ un }}" + password: "{{ pwd }}" # TACACS Server Host Configuration - name: "Tacacs Server Host Configuration" diff --git a/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py b/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py index 8b8ad6620a..c1ee7c9b13 100644 --- a/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py +++ b/lib/ansible/modules/network/nxos/nxos_igmp_snooping.py @@ -86,8 +86,8 @@ EXAMPLES = ''' report_supp: true v3_report_supp: true host: "{{ inventory_hostname }}" - username: {{ un }} - password: {{ pwd }} + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_mtu.py b/lib/ansible/modules/network/nxos/nxos_mtu.py index 26fccca615..58942a277b 100644 --- a/lib/ansible/modules/network/nxos/nxos_mtu.py +++ b/lib/ansible/modules/network/nxos/nxos_mtu.py @@ -57,33 +57,33 @@ EXAMPLES = ''' # Ensure system mtu is 9126 - nxos_mtu: sysmtu: 9216 - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + 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 }} + 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 }} + 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 }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" state: absent ''' diff --git a/lib/ansible/modules/network/nxos/nxos_ntp.py b/lib/ansible/modules/network/nxos/nxos_ntp.py index 18cbe2b1a7..f99f1876a6 100644 --- a/lib/ansible/modules/network/nxos/nxos_ntp.py +++ b/lib/ansible/modules/network/nxos/nxos_ntp.py @@ -81,9 +81,9 @@ EXAMPLES = ''' server: 1.2.3.4 key_id: 32 prefer: enabled - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_ntp_auth.py b/lib/ansible/modules/network/nxos/nxos_ntp_auth.py index 9790389b9c..e6652e1bfb 100644 --- a/lib/ansible/modules/network/nxos/nxos_ntp_auth.py +++ b/lib/ansible/modules/network/nxos/nxos_ntp_auth.py @@ -77,9 +77,9 @@ EXAMPLES = ''' key_id: 32 md5string: hello auth_type: text - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_ntp_options.py b/lib/ansible/modules/network/nxos/nxos_ntp_options.py index ba9018acce..4fc2312440 100644 --- a/lib/ansible/modules/network/nxos/nxos_ntp_options.py +++ b/lib/ansible/modules/network/nxos/nxos_ntp_options.py @@ -65,9 +65,9 @@ EXAMPLES = ''' master: true stratum: 12 logging: false - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_nxapi.py b/lib/ansible/modules/network/nxos/nxos_nxapi.py index 3324130b17..f8144aba45 100644 --- a/lib/ansible/modules/network/nxos/nxos_nxapi.py +++ b/lib/ansible/modules/network/nxos/nxos_nxapi.py @@ -112,7 +112,7 @@ vars: - name: Enable NXAPI access with default configuration nxos_nxapi: - provider: {{ cli }} + provider: "{{ cli }}" - name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled nxos_nxapi: @@ -120,12 +120,12 @@ vars: https_port: 9443 https: yes enable_sandbox: no - provider: {{ cli }} + provider: "{{ cli }}" - name: remove NXAPI configuration nxos_nxapi: state: absent - provider: {{ cli }} + provider: "{{ cli }}" """ RETURN = """ diff --git a/lib/ansible/modules/network/nxos/nxos_pim_interface.py b/lib/ansible/modules/network/nxos/nxos_pim_interface.py index 9556b03ab6..6a62756552 100644 --- a/lib/ansible/modules/network/nxos/nxos_pim_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_pim_interface.py @@ -110,9 +110,9 @@ EXAMPLES = ''' - nxos_pim_interface: interface: eth1/33 state: absent - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" # ensure the interface has pim-sm enabled with the appropriate priority and hello interval - nxos_pim_interface: @@ -120,9 +120,9 @@ EXAMPLES = ''' dr_prio: 10 hello_interval: 40 state: present - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" # ensure join-prune policies exist - nxos_pim_interface: @@ -131,17 +131,17 @@ EXAMPLES = ''' jp_policy_out: JPOUT jp_type_in: routemap jp_type_out: routemap - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + 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 }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_community.py b/lib/ansible/modules/network/nxos/nxos_snmp_community.py index 5abc428fb8..7ffe7b46e5 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_community.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_community.py @@ -62,9 +62,9 @@ EXAMPLES = ''' community: TESTING7 group: network-operator state: present - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_contact.py b/lib/ansible/modules/network/nxos/nxos_snmp_contact.py index aaaeab4fb7..e2d9873368 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_contact.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_contact.py @@ -47,9 +47,9 @@ EXAMPLES = ''' - nxos_snmp_contact: contact: Test state: present - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_host.py b/lib/ansible/modules/network/nxos/nxos_snmp_host.py index f00c755770..631f24a065 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_host.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_host.py @@ -82,9 +82,9 @@ EXAMPLES = ''' snmp_host: 3.3.3.3 community: TESTING state: present - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_location.py b/lib/ansible/modules/network/nxos/nxos_snmp_location.py index 528200dec7..f35b79a3f9 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_location.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_location.py @@ -44,17 +44,17 @@ EXAMPLES = ''' - nxos_snmp_location: location: Test state: present - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + 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 }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_traps.py b/lib/ansible/modules/network/nxos/nxos_snmp_traps.py index 63f1a3e3e7..a615c492c0 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_traps.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_traps.py @@ -54,17 +54,17 @@ EXAMPLES = ''' - nxos_snmp_traps: group: lldp state: enabled - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + 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 }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_snmp_user.py b/lib/ansible/modules/network/nxos/nxos_snmp_user.py index d3add9b761..56d515a8ff 100644 --- a/lib/ansible/modules/network/nxos/nxos_snmp_user.py +++ b/lib/ansible/modules/network/nxos/nxos_snmp_user.py @@ -73,9 +73,9 @@ EXAMPLES = ''' group: network-operator auth: md5 pwd: test_password - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_udld.py b/lib/ansible/modules/network/nxos/nxos_udld.py index db53461f92..7f8cedeca9 100644 --- a/lib/ansible/modules/network/nxos/nxos_udld.py +++ b/lib/ansible/modules/network/nxos/nxos_udld.py @@ -62,17 +62,17 @@ EXAMPLES = ''' - nxos_udld: aggressive: disabled msg_time: 20 - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + 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 }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_udld_interface.py b/lib/ansible/modules/network/nxos/nxos_udld_interface.py index e061dde465..6647349540 100644 --- a/lib/ansible/modules/network/nxos/nxos_udld_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_udld_interface.py @@ -51,26 +51,26 @@ EXAMPLES = ''' interface: Ethernet1/1 mode: aggressive state: present - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + 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 }} + 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 }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vtp_domain.py b/lib/ansible/modules/network/nxos/nxos_vtp_domain.py index 54704913cd..93f62318e2 100644 --- a/lib/ansible/modules/network/nxos/nxos_vtp_domain.py +++ b/lib/ansible/modules/network/nxos/nxos_vtp_domain.py @@ -45,9 +45,9 @@ EXAMPLES = ''' # ENSURE VTP DOMAIN IS CONFIGURED - nxos_vtp_domain: domain: ntc - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vtp_password.py b/lib/ansible/modules/network/nxos/nxos_vtp_password.py index 3fc504273e..a167e37363 100644 --- a/lib/ansible/modules/network/nxos/nxos_vtp_password.py +++ b/lib/ansible/modules/network/nxos/nxos_vtp_password.py @@ -56,17 +56,17 @@ EXAMPLES = ''' - nxos_vtp_password: password: ntc state: present - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + 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 }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vtp_version.py b/lib/ansible/modules/network/nxos/nxos_vtp_version.py index 90fad19016..5ce455d81c 100644 --- a/lib/ansible/modules/network/nxos/nxos_vtp_version.py +++ b/lib/ansible/modules/network/nxos/nxos_vtp_version.py @@ -43,9 +43,9 @@ EXAMPLES = ''' # ENSURE VTP VERSION IS 2 - nxos_vtp_version: version: 2 - host: {{ inventory_hostname }} - username: {{ un }} - password: {{ pwd }} + host: "{{ inventory_hostname }}" + username: "{{ un }}" + password: "{{ pwd }}" ''' RETURN = ''' diff --git a/lib/ansible/modules/network/sros/sros_config.py b/lib/ansible/modules/network/sros/sros_config.py index f1fd84a8bb..27c62fd536 100644 --- a/lib/ansible/modules/network/sros/sros_config.py +++ b/lib/ansible/modules/network/sros/sros_config.py @@ -186,7 +186,7 @@ vars: - name: load config from file sros_config: - src: {{ inventory_hostname }}.cfg + src: "{{ inventory_hostname }}.cfg" provider: "{{ cli }}" save: yes """