Add examples and language to better showcase the 'parents' parameter in multiple network modules (#34486)

* Add additional language and examples for 'parents' parameter to clarify its usage.
pull/35953/merge
Tyler 7 years ago committed by John R Barker
parent 6cbd7cc5d8
commit 15b0371eb2

@ -36,7 +36,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -37,7 +37,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -43,7 +43,7 @@ options:
default: null default: null
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -39,7 +39,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -37,7 +37,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -38,7 +38,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -49,7 +49,7 @@ options:
default: null default: null
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -48,7 +48,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.
@ -237,6 +237,27 @@ EXAMPLES = """
- ip address 172.31.1.1 255.255.255.0 - ip address 172.31.1.1 255.255.255.0
parents: interface Ethernet1 parents: interface Ethernet1
- name: configure ip helpers on multiple interfaces
ios_config:
lines:
- ip helper-address 172.26.1.10
- ip helper-address 172.26.3.8
parents: "{{ item }}"
with_items:
- interface Ethernet1
- interface Ethernet2
- interface GigabitEthernet1
- name: configure policer in Scavenger class
ios_config:
lines:
- conform-action transmit
- exceed-action drop
parents:
- policy-map Foo
- class Scavenger
- police cir 64000
- name: load new acl into device - name: load new acl into device
ios_config: ios_config:
lines: lines:

@ -41,7 +41,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -47,7 +47,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -36,7 +36,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

@ -38,7 +38,7 @@ options:
aliases: ['commands'] aliases: ['commands']
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - The ordered set of parents that uniquely identify the section or hierarchy
the commands should be checked against. If the parents argument the commands should be checked against. If the parents argument
is omitted, the commands are checked against the set of top is omitted, the commands are checked against the set of top
level or global commands. level or global commands.

Loading…
Cancel
Save