diff --git a/changelogs/fragments/79-Use-FQCN-to-M-references b/changelogs/fragments/79-Use-FQCN-to-M-references new file mode 100644 index 00000000..6dbeea78 --- /dev/null +++ b/changelogs/fragments/79-Use-FQCN-to-M-references @@ -0,0 +1,3 @@ +--- +minor_changes: + - Use FQCN to M() references in modules documentation (https://github.com/ansible-collections/junipernetworks.junos/pull/79) diff --git a/plugins/modules/junos_facts.py b/plugins/modules/junos_facts.py index a77f51bd..50bd1b68 100644 --- a/plugins/modules/junos_facts.py +++ b/plugins/modules/junos_facts.py @@ -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. @@ -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'. diff --git a/plugins/modules/junos_interface.py b/plugins/modules/junos_interface.py index 3e2587a9..f289c7ec 100644 --- a/plugins/modules/junos_interface.py +++ b/plugins/modules/junos_interface.py @@ -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: diff --git a/plugins/modules/junos_l2_interface.py b/plugins/modules/junos_l2_interface.py index 49ca2bdc..127b52dc 100644 --- a/plugins/modules/junos_l2_interface.py +++ b/plugins/modules/junos_l2_interface.py @@ -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: diff --git a/plugins/modules/junos_l3_interface.py b/plugins/modules/junos_l3_interface.py index d061d902..4b7fc3c5 100644 --- a/plugins/modules/junos_l3_interface.py +++ b/plugins/modules/junos_l3_interface.py @@ -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: diff --git a/plugins/modules/junos_linkagg.py b/plugins/modules/junos_linkagg.py index 2e45aaa7..4c01fc9f 100644 --- a/plugins/modules/junos_linkagg.py +++ b/plugins/modules/junos_linkagg.py @@ -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: diff --git a/plugins/modules/junos_lldp.py b/plugins/modules/junos_lldp.py index b1cafd9d..7a484a75 100644 --- a/plugins/modules/junos_lldp.py +++ b/plugins/modules/junos_lldp.py @@ -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: diff --git a/plugins/modules/junos_lldp_interface.py b/plugins/modules/junos_lldp_interface.py index d1d0d422..e71ea887 100644 --- a/plugins/modules/junos_lldp_interface.py +++ b/plugins/modules/junos_lldp_interface.py @@ -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: diff --git a/plugins/modules/junos_ping.py b/plugins/modules/junos_ping.py index 1a683636..697c1f2d 100644 --- a/plugins/modules/junos_ping.py +++ b/plugins/modules/junos_ping.py @@ -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) @@ -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 diff --git a/plugins/modules/junos_static_route.py b/plugins/modules/junos_static_route.py index 9e1a39db..c1278c52 100644 --- a/plugins/modules/junos_static_route.py +++ b/plugins/modules/junos_static_route.py @@ -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: diff --git a/plugins/modules/junos_vlan.py b/plugins/modules/junos_vlan.py index 5b3e215a..4b07904d 100644 --- a/plugins/modules/junos_vlan.py +++ b/plugins/modules/junos_vlan.py @@ -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: