Skip to content

Commit

Permalink
Use FQCN to M() references (#79)
Browse files Browse the repository at this point in the history
Use FQCN to M() references

Reviewed-by: Rohit Thakur <[email protected]>
             https://github.com/rohitthakur2590
  • Loading branch information
bmillemathias authored Sep 17, 2020
1 parent 5b1049e commit 1a33c22
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 16 deletions.
3 changes: 3 additions & 0 deletions changelogs/fragments/79-Use-FQCN-to-M-references
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
minor_changes:
- Use FQCN to M() references in modules documentation (https://github.com/ansible-collections/junipernetworks.junos/pull/79)
4 changes: 2 additions & 2 deletions plugins/modules/junos_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
- When supplied, this argument will restrict the facts collected to a given subset. Possible
values for this argument include all, hardware, config, and interfaces. Can
specify a list of values to include a larger subset. Values can also be used
with an initial C(M(!)) to specify that a specific subset should not be collected.
with an initial C(!) to specify that a specific subset should not be collected.
To maintain backward compatibility old style facts can be retrieved by explicitly
adding C(ofacts) to value, this requires junos-eznc to be installed as a prerequisite.
Valid value of gather_subset are default, hardware, config, interfaces, ofacts.
Expand Down Expand Up @@ -61,7 +61,7 @@
- When supplied, this argument will restrict the facts collected to a given subset.
Possible values for this argument include all and the resources like interfaces,
vlans etc. Can specify a list of values to include a larger subset. Values can
also be used with an initial C(M(!)) to specify that a specific subset should
also be used with an initial C(!) to specify that a specific subset should
not be collected. Valid subsets are 'all', 'interfaces', 'lacp', 'lacp_interfaces',
'lag_interfaces', 'l2_interfaces', 'l3_interfaces', 'lldp_global', 'lldp_interfaces',
'vlans'.
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_interfaces) instead.
alternative: Use M(junipernetworks.junos.junos_interfaces) instead.
removed_at_date: '2022-06-01'
options:
name:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_l2_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_l2_interfaces) instead.
alternative: Use M(junipernetworks.junos.junos_l2_interfaces) instead.
removed_at_date: '2022-06-01'
options:
name:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_l3_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_l3_interfaces) instead.
alternative: Use M(junipernetworks.junos.junos_l3_interfaces) instead.
removed_at_date: '2022-06-01'
options:
name:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_linkagg.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_lag_interfaces) instead.
alternative: Use M(junipernetworks.junos.junos_lag_interfaces) instead.
removed_at_date: '2022-06-01'
options:
name:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_lldp.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_lldp_global) instead.
alternative: Use M(junipernetworks.junos.junos_lldp_global) instead.
removed_at_date: '2022-06-01'
options:
interval:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_lldp_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_lldp_interfaces) instead.
alternative: Use M(junipernetworks.junos.junos_lldp_interfaces) instead.
removed_at_date: '2022-06-01'
options:
name:
Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/junos_ping.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
description:
- Tests reachability using ping from devices running Juniper JUNOS to a remote destination.
- Tested against Junos (17.3R1.10)
- For a general purpose network module, see the M(net_ping) module.
- For Windows targets, use the M(win_ping) module instead.
- For targets running Python, use the M(ping) module instead.
- For a general purpose network module, see the M(ansible.netcommon.net_ping) module.
- For Windows targets, use the M(ansible.windows.win_ping) module instead.
- For targets running Python, use the M(ansible.builtin.ping) module instead.
version_added: 1.0.0
author:
- Nilashish Chakraborty (@NilashishC)
Expand Down Expand Up @@ -61,9 +61,9 @@
- present
default: present
notes:
- For a general purpose network module, see the M(net_ping) module.
- For Windows targets, use the M(win_ping) module instead.
- For targets running Python, use the M(ping) module instead.
- For a general purpose network module, see the M(ansible.netcommon..net_ping) module.
- For Windows targets, use the M(ansible.windows.win_ping) module instead.
- For targets running Python, use the M(ansible.builtin.ping) module instead.
- This module works only with connection C(network_cli).
extends_documentation_fragment:
- junipernetworks.junos.junos
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_static_route.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_static_routes) instead.
alternative: Use M(junipernetworks.junos.junos_static_routes) instead.
removed_at_date: '2022-06-01'
options:
address:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/junos_vlan.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
version_added: 1.0.0
deprecated:
why: Updated modules released with more functionality
alternative: Use M(junos_vlans) instead.
alternative: Use M(junipernetworks.junos.junos_vlans) instead.
removed_at_date: '2022-06-01'
options:
name:
Expand Down

0 comments on commit 1a33c22

Please sign in to comment.