Remove potentially confusing `provider` from module documentation (#35851)

pull/35868/head
Nathaniel Case 7 years ago committed by GitHub
parent 07221d777a
commit dfcae9fc8e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -55,31 +55,22 @@ notes:
''' '''
EXAMPLES = r''' EXAMPLES = r'''
- provider:
host: "{{ ansible_host }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Test reachability to 10.10.10.10 using default vrf - name: Test reachability to 10.10.10.10 using default vrf
ios_ping: ios_ping:
provider: "{{ provider }}"
dest: 10.10.10.10 dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using prod vrf - name: Test reachability to 10.20.20.20 using prod vrf
ios_ping: ios_ping:
provider: "{{ provider }}"
dest: 10.20.20.20 dest: 10.20.20.20
vrf: prod vrf: prod
- name: Test unreachability to 10.30.30.30 using default vrf - name: Test unreachability to 10.30.30.30 using default vrf
ios_ping: ios_ping:
provider: "{{ provider }}"
dest: 10.30.30.30 dest: 10.30.30.30
state: absent state: absent
- name: Test reachability to 10.40.40.40 using prod vrf and setting count and source - name: Test reachability to 10.40.40.40 using prod vrf and setting count and source
ios_ping: ios_ping:
provider: "{{ provider }}"
dest: 10.40.40.40 dest: 10.40.40.40
source: loopback0 source: loopback0
vrf: prod vrf: prod

@ -152,7 +152,6 @@ EXAMPLES = """
junos_config: junos_config:
src: srx.cfg src: srx.cfg
comment: update config comment: update config
provider: "{{ netconf }}"
- name: load configure lines into device - name: load configure lines into device
junos_config: junos_config:
@ -160,22 +159,18 @@ EXAMPLES = """
- set interfaces ge-0/0/1 unit 0 description "Test interface" - set interfaces ge-0/0/1 unit 0 description "Test interface"
- set vlans vlan01 description "Test vlan" - set vlans vlan01 description "Test vlan"
comment: update config comment: update config
provider: "{{ netconf }}"
- name: rollback the configuration to id 10 - name: rollback the configuration to id 10
junos_config: junos_config:
rollback: 10 rollback: 10
provider: "{{ netconf }}"
- name: zero out the current configuration - name: zero out the current configuration
junos_config: junos_config:
zeroize: yes zeroize: yes
provider: "{{ netconf }}"
- name: confirm a previous commit - name: confirm a previous commit
junos_config: junos_config:
confirm_commit: yes confirm_commit: yes
provider: "{{ netconf }}"
""" """
RETURN = """ RETURN = """

@ -210,7 +210,6 @@ EXAMPLES = '''
src: 1.1.1.1/24 src: 1.1.1.1/24
dest: any dest: any
state: present state: present
provider: "{{ nxos_provider }}"
''' '''
RETURN = ''' RETURN = '''

@ -26,11 +26,10 @@ description:
options: options:
commands: commands:
description: description:
- The commands to send to the remote NXOS device over the - The commands to send to the remote NXOS device. The resulting
configured provider. The resulting output from the command output from the command is returned. If the I(wait_for)
is returned. If the I(wait_for) argument is provided, the argument is provided, the module is not returned until the
module is not returned until the condition is satisfied or condition is satisfied or the number of retires as expired.
the number of retires as expired.
- The I(commands) argument also accepts an alternative form - The I(commands) argument also accepts an alternative form
that allows for complex values that specify the command that allows for complex values that specify the command
to run and the output format to return. This can be done to run and the output format to return. This can be done
@ -79,34 +78,21 @@ options:
""" """
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
---
vars:
cli:
host: "{{ inventory_hostname }}"
username: admin
password: admin
transport: cli
--- ---
- name: run show version on remote devices - name: run show version on remote devices
nxos_command: nxos_command:
commands: show version commands: show version
provider: "{{ cli }}"
- name: run show version and check to see if output contains Cisco - name: run show version and check to see if output contains Cisco
nxos_command: nxos_command:
commands: show version commands: show version
wait_for: result[0] contains Cisco wait_for: result[0] contains Cisco
provider: "{{ cli }}"
- name: run multiple commands on remote nodes - name: run multiple commands on remote nodes
nxos_command: nxos_command:
commands: commands:
- show version - show version
- show interfaces - show interfaces
provider: "{{ cli }}"
- name: run multiple commands and evaluate the output - name: run multiple commands and evaluate the output
nxos_command: nxos_command:
@ -116,14 +102,12 @@ vars:
wait_for: wait_for:
- result[0] contains Cisco - result[0] contains Cisco
- result[1] contains loopback0 - result[1] contains loopback0
provider: "{{ cli }}"
- name: run commands and specify the output format - name: run commands and specify the output format
nxos_command: nxos_command:
commands: commands:
- command: show version - command: show version
output: json output: json
provider: "{{ cli }}"
""" """
RETURN = """ RETURN = """

@ -55,32 +55,22 @@ notes:
EXAMPLES = r''' EXAMPLES = r'''
- provider:
host: "{{ ansible_host }}"
username: "{{ username }}"
password: "{{ password }}"
network_os: "{{ network_os }}"
- name: Test reachability to 10.10.10.10 using default vrf - name: Test reachability to 10.10.10.10 using default vrf
net_ping: net_ping:
provider: "{{ provider }}"
dest: 10.10.10.10 dest: 10.10.10.10
- name: Test reachability to 10.20.20.20 using prod vrf - name: Test reachability to 10.20.20.20 using prod vrf
net_ping: net_ping:
provider: "{{ provider }}"
dest: 10.20.20.20 dest: 10.20.20.20
vrf: prod vrf: prod
- name: Test unreachability to 10.30.30.30 using default vrf - name: Test unreachability to 10.30.30.30 using default vrf
net_ping: net_ping:
provider: "{{ provider }}"
dest: 10.30.30.30 dest: 10.30.30.30
state: absent state: absent
- name: Test reachability to 10.40.40.40 using prod vrf and setting count and source - name: Test reachability to 10.40.40.40 using prod vrf and setting count and source
net_ping: net_ping:
provider: "{{ provider }}"
dest: 10.40.40.40 dest: 10.40.40.40
source: loopback0 source: loopback0
vrf: prod vrf: prod

Loading…
Cancel
Save