Browse code

Intersphinx (#68090)

* try to route 2.9 porting guide links to 2.9 module docs

* refreshed existing .inv files

* better URL

* new .inv file for version-specific links

* adds targets for version-specific docs

* fixes 2.5 porting guide refs

* fixes 2.8 porting guide refs

* fixes 2.7 porting guide refs

* fixes links on ACI guide

* adds .inv files for versions 2.5 through 2.8

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>

Alicia Cozine authored on 2020/03/07 07:16:35
Showing 13 changed files
1 1
new file mode 100644
2 2
Binary files /dev/null and b/docs/docsite/ansible_2_5.inv differ
3 3
new file mode 100644
4 4
Binary files /dev/null and b/docs/docsite/ansible_2_6.inv differ
5 5
new file mode 100644
6 6
Binary files /dev/null and b/docs/docsite/ansible_2_7.inv differ
7 7
new file mode 100644
8 8
Binary files /dev/null and b/docs/docsite/ansible_2_8.inv differ
9 9
new file mode 100644
10 10
Binary files /dev/null and b/docs/docsite/ansible_2_9.inv differ
11 11
Binary files a/docs/docsite/jinja2.inv and b/docs/docsite/jinja2.inv differ
12 12
Binary files a/docs/docsite/python3.inv and b/docs/docsite/python3.inv differ
... ...
@@ -276,4 +276,10 @@ autoclass_content = 'both'
276 276
 # location for the mappning to live) will confuse it.
277 277
 intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2.inv')),
278 278
                        'python3': ('https://docs.python.org/3/', (None, '../python3.inv')),
279
-                       'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv'))}
279
+                       'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')),
280
+                       'ansible_2_9': ('https://docs.ansible.com/ansible/2.9/', (None, '../ansible_2_9.inv')),
281
+                       'ansible_2_8': ('https://docs.ansible.com/ansible/2.8/', (None, '../ansible_2_8.inv')),
282
+                       'ansible_2_7': ('https://docs.ansible.com/ansible/2.7/', (None, '../ansible_2_7.inv')),
283
+                       'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')),
284
+                       'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')),
285
+                       }
... ...
@@ -169,17 +169,17 @@ Modules removed
169 169
 
170 170
 The following modules no longer exist:
171 171
 
172
-* nxos_mtu use :ref:`nxos_system <nxos_system_module>`'s ``system_mtu`` option or :ref:`nxos_interface <nxos_interface_module>` instead
173
-* cl_interface_policy use :ref:`nclu <nclu_module>` instead
174
-* cl_bridge use :ref:`nclu <nclu_module>` instead
175
-* cl_img_install use :ref:`nclu <nclu_module>` instead
176
-* cl_ports use :ref:`nclu <nclu_module>` instead
177
-* cl_license use :ref:`nclu <nclu_module>` instead
178
-* cl_interface use :ref:`nclu <nclu_module>` instead
179
-* cl_bond use :ref:`nclu <nclu_module>` instead
180
-* ec2_vpc use :ref:`ec2_vpc_net <ec2_vpc_net_module>` along with supporting modules :ref:`ec2_vpc_igw <ec2_vpc_igw_module>`, :ref:`ec2_vpc_route_table <ec2_vpc_route_table_module>`, :ref:`ec2_vpc_subnet <ec2_vpc_subnet_module>`, :ref:`ec2_vpc_dhcp_option <ec2_vpc_dhcp_option_module>`, :ref:`ec2_vpc_nat_gateway <ec2_vpc_nat_gateway_module>`, :ref:`ec2_vpc_nacl <ec2_vpc_nacl_module>` instead.
181
-* ec2_ami_search use :ref:`ec2_ami_facts <ec2_ami_facts_module>` instead
182
-* docker use :ref:`docker_container <docker_container_module>` and :ref:`docker_image <docker_image_module>` instead
172
+* nxos_mtu use :ref:`nxos_system <ansible_2_5:nxos_system_module>`'s ``system_mtu`` option or :ref:`nxos_interface <ansible_2_5:nxos_interface_module>` instead
173
+* cl_interface_policy use :ref:`nclu <ansible_2_5:nclu_module>` instead
174
+* cl_bridge use :ref:`nclu <ansible_2_5:nclu_module>` instead
175
+* cl_img_install use :ref:`nclu <ansible_2_5:nclu_module>` instead
176
+* cl_ports use :ref:`nclu <ansible_2_5:nclu_module>` instead
177
+* cl_license use :ref:`nclu <ansible_2_5:nclu_module>` instead
178
+* cl_interface use :ref:`nclu <ansible_2_5:nclu_module>` instead
179
+* cl_bond use :ref:`nclu <ansible_2_5:nclu_module>` instead
180
+* ec2_vpc use :ref:`ec2_vpc_net <ansible_2_5:ec2_vpc_net_module>` along with supporting modules :ref:`ec2_vpc_igw <ansible_2_5:ec2_vpc_igw_module>`, :ref:`ec2_vpc_route_table <ansible_2_5:ec2_vpc_route_table_module>`, :ref:`ec2_vpc_subnet <ansible_2_5:ec2_vpc_subnet_module>`, :ref:`ec2_vpc_dhcp_option <ansible_2_5:ec2_vpc_dhcp_option_module>`, :ref:`ec2_vpc_nat_gateway <ansible_2_5:ec2_vpc_nat_gateway_module>`, :ref:`ec2_vpc_nacl <ansible_2_5:ec2_vpc_nacl_module>` instead.
181
+* ec2_ami_search use :ref:`ec2_ami_facts <ansible_2_5:ec2_ami_facts_module>` instead
182
+* docker use :ref:`docker_container <ansible_2_5:docker_container_module>` and :ref:`docker_image <ansible_2_5:docker_image_module>` instead
183 183
 
184 184
 .. note::
185 185
 
... ...
@@ -196,37 +196,37 @@ Deprecation notices
196 196
 The following modules will be removed in Ansible 2.9. Please update your playbooks accordingly.
197 197
 
198 198
 * Apstra's ``aos_*`` modules are deprecated as they do not work with AOS 2.1 or higher. See new modules at `https://github.com/apstra <https://github.com/apstra>`_.
199
-* nxos_ip_interface use :ref:`nxos_l3_interface <nxos_l3_interface_module>` instead.
200
-* nxos_portchannel use :ref:`nxos_linkagg <nxos_linkagg_module>` instead.
201
-* nxos_switchport use :ref:`nxos_l2_interface <nxos_l2_interface_module>` instead.
202
-* panos_security_policy use :ref:`panos_security_rule <panos_security_rule_module>` instead.
203
-* panos_nat_policy use :ref:`panos_nat_rule <panos_nat_rule_module>` instead.
204
-* vsphere_guest use :ref:`vmware_guest <vmware_guest_module>` instead.
199
+* nxos_ip_interface use :ref:`nxos_l3_interface <ansible_2_5:nxos_l3_interface_module>` instead.
200
+* nxos_portchannel use :ref:`nxos_linkagg <ansible_2_5:nxos_linkagg_module>` instead.
201
+* nxos_switchport use :ref:`nxos_l2_interface <ansible_2_5:nxos_l2_interface_module>` instead.
202
+* panos_security_policy use :ref:`panos_security_rule <ansible_2_5:panos_security_rule_module>` instead.
203
+* panos_nat_policy use :ref:`panos_nat_rule <ansible_2_5:panos_nat_rule_module>` instead.
204
+* vsphere_guest use :ref:`vmware_guest <ansible_2_5:vmware_guest_module>` instead.
205 205
 
206 206
 Noteworthy module changes
207 207
 -------------------------
208 208
 
209
-* The :ref:`stat <stat_module>` and :ref:`win_stat <win_stat_module>` modules have changed the default of the option ``get_md5`` from ``true`` to ``false``.
209
+* The :ref:`stat <ansible_2_5:stat_module>` and :ref:`win_stat <ansible_2_5:win_stat_module>` modules have changed the default of the option ``get_md5`` from ``true`` to ``false``.
210 210
 
211 211
 This option will be removed starting with Ansible version 2.9. The options ``get_checksum: True``
212 212
 and ``checksum_algorithm: md5`` can still be used if an MD5 checksum is
213 213
 desired.
214 214
 
215
-* ``osx_say`` module was renamed into :ref:`say <say_module>`.
215
+* ``osx_say`` module was renamed into :ref:`say <ansible_2_5:say_module>`.
216 216
 * Several modules which could deal with symlinks had the default value of their ``follow`` option
217 217
   changed as part of a feature to `standardize the behavior of follow
218 218
   <https://github.com/ansible/proposals/issues/69>`_:
219 219
 
220
-  * The :ref:`file module <file_module>` changed from ``follow=False`` to ``follow=True`` because
220
+  * The :ref:`file module <ansible_2_5:file_module>` changed from ``follow=False`` to ``follow=True`` because
221 221
     its purpose is to modify the attributes of a file and most systems do not allow attributes to be
222 222
     applied to symlinks, only to real files.
223
-  * The :ref:`replace module <replace_module>` had its ``follow`` parameter removed because it
223
+  * The :ref:`replace module <ansible_2_5:replace_module>` had its ``follow`` parameter removed because it
224 224
     inherently modifies the content of an existing file so it makes no sense to operate on the link
225 225
     itself.
226
-  * The :ref:`blockinfile module <blockinfile_module>` had its ``follow`` parameter removed because
226
+  * The :ref:`blockinfile module <ansible_2_5:blockinfile_module>` had its ``follow`` parameter removed because
227 227
     it inherently modifies the content of an existing file so it makes no sense to operate on the
228 228
     link itself.
229
-  * In Ansible-2.5.3, the :ref:`template module <template_module>` became more strict about its
229
+  * In Ansible-2.5.3, the :ref:`template module <ansible_2_5:template_module>` became more strict about its
230 230
     ``src`` file being proper utf-8.  Previously, non-utf8 contents in a template module src file
231 231
     would result in a mangled output file (the non-utf8 characters would be replaced with a unicode
232 232
     replacement character).  Now, on Python2, the module will error out with the message, "Template
... ...
@@ -114,7 +114,7 @@ Before the introduction of AnsiBallZ in Ansible 2.1, using ``__file__`` worked i
114 114
 
115 115
 Ansible 2.8 will no longer create a temporary file for ``AnsibleModule``; instead it will read the file out of a zip file. This change should speed up module execution, but it does mean that starting with Ansible 2.8, referencing ``__file__`` will always fail in ``AnsibleModule``.
116 116
 
117
-If you are the author of a third-party module which uses ``__file__`` with ``AnsibleModule``, please update your module(s) now, while the use of ``__file__`` is deprecated but still available. The most common use of ``__file__`` is to find a directory to write a temporary file. In Ansible 2.5 and above, you can use the ``tmpdir`` attribute on an ``AnsibleModule`` instance instead, as shown in this code from the :ref:`apt module <apt_module>`:
117
+If you are the author of a third-party module which uses ``__file__`` with ``AnsibleModule``, please update your module(s) now, while the use of ``__file__`` is deprecated but still available. The most common use of ``__file__`` is to find a directory to write a temporary file. In Ansible 2.5 and above, you can use the ``tmpdir`` attribute on an ``AnsibleModule`` instance instead, as shown in this code from the :ref:`apt module <ansible_2_7:apt_module>`:
118 118
 
119 119
 .. code-block:: diff
120 120
 
... ...
@@ -175,19 +175,19 @@ Deprecation notices
175 175
 
176 176
 The following modules will be removed in Ansible 2.11. Please update your playbooks accordingly.
177 177
 
178
-* ``na_cdot_aggregate`` use :ref:`na_ontap_aggregate <na_ontap_aggregate_module>` instead.
179
-* ``na_cdot_license`` use :ref:`na_ontap_license <na_ontap_license_module>` instead.
180
-* ``na_cdot_lun`` use :ref:`na_ontap_lun <na_ontap_lun_module>` instead.
181
-* ``na_cdot_qtree`` use :ref:`na_ontap_qtree <na_ontap_qtree_module>` instead.
182
-* ``na_cdot_svm`` use :ref:`na_ontap_svm <na_ontap_svm_module>` instead.
183
-* ``na_cdot_user`` use :ref:`na_ontap_user <na_ontap_user_module>` instead.
184
-* ``na_cdot_user_role`` use :ref:`na_ontap_user_role <na_ontap_user_role_module>` instead.
185
-* ``na_cdot_volume`` use :ref:`na_ontap_volume <na_ontap_volume_module>` instead.
186
-* ``sf_account_manager`` use :ref:`na_elementsw_account<na_elementsw_account_module>` instead.
187
-* ``sf_check_connections`` use :ref:`na_elementsw_check_connections<na_elementsw_check_connections_module>` instead.
188
-* ``sf_snapshot_schedule_manager`` use :ref:`na_elementsw_snapshot_schedule<na_elementsw_snapshot_schedule_module>` instead.
189
-* ``sf_volume_access_group_manager`` use :ref:`na_elementsw_access_group<na_elementsw_access_group_module>` instead.
190
-* ``sf_volume_manager`` use :ref:`na_elementsw_volume<na_elementsw_volume_module>` instead.
178
+* ``na_cdot_aggregate`` use :ref:`na_ontap_aggregate <ansible_2_7:na_ontap_aggregate_module>` instead.
179
+* ``na_cdot_license`` use :ref:`na_ontap_license <ansible_2_7:na_ontap_license_module>` instead.
180
+* ``na_cdot_lun`` use :ref:`na_ontap_lun <ansible_2_7:na_ontap_lun_module>` instead.
181
+* ``na_cdot_qtree`` use :ref:`na_ontap_qtree <ansible_2_7:na_ontap_qtree_module>` instead.
182
+* ``na_cdot_svm`` use :ref:`na_ontap_svm <ansible_2_7:na_ontap_svm_module>` instead.
183
+* ``na_cdot_user`` use :ref:`na_ontap_user <ansible_2_7:na_ontap_user_module>` instead.
184
+* ``na_cdot_user_role`` use :ref:`na_ontap_user_role <ansible_2_7:na_ontap_user_role_module>` instead.
185
+* ``na_cdot_volume`` use :ref:`na_ontap_volume <ansible_2_7:na_ontap_volume_module>` instead.
186
+* ``sf_account_manager`` use :ref:`na_elementsw_account<ansible_2_7:na_elementsw_account_module>` instead.
187
+* ``sf_check_connections`` use :ref:`na_elementsw_check_connections<ansible_2_7:na_elementsw_check_connections_module>` instead.
188
+* ``sf_snapshot_schedule_manager`` use :ref:`na_elementsw_snapshot_schedule<ansible_2_7:na_elementsw_snapshot_schedule_module>` instead.
189
+* ``sf_volume_access_group_manager`` use :ref:`na_elementsw_access_group<ansible_2_7:na_elementsw_access_group_module>` instead.
190
+* ``sf_volume_manager`` use :ref:`na_elementsw_volume<ansible_2_7:na_elementsw_volume_module>` instead.
191 191
 
192 192
 Noteworthy module changes
193 193
 -------------------------
... ...
@@ -389,17 +389,17 @@ The following modules will be removed in Ansible 2.12. Please update your playbo
389 389
 
390 390
 * ``foreman`` use `foreman-ansible-modules <https://github.com/theforeman/foreman-ansible-modules>`_ instead.
391 391
 * ``katello`` use `foreman-ansible-modules <https://github.com/theforeman/foreman-ansible-modules>`_ instead.
392
-* ``github_hooks`` use :ref:`github_webhook <github_webhook_module>` and :ref:`github_webhook_facts <github_webhook_facts_module>` instead.
393
-* ``digital_ocean`` use :ref:`digital_ocean_droplet <digital_ocean_droplet_module>` instead.
394
-* ``gce`` use :ref:`gcp_compute_instance <gcp_compute_instance_module>` instead.
395
-* ``gcspanner`` use :ref:`gcp_spanner_instance <gcp_spanner_instance_module>` and :ref:`gcp_spanner_database <gcp_spanner_database_module>` instead.
396
-* ``gcdns_record`` use :ref:`gcp_dns_resource_record_set <gcp_dns_resource_record_set_module>` instead.
397
-* ``gcdns_zone`` use :ref:`gcp_dns_managed_zone <gcp_dns_managed_zone_module>` instead.
398
-* ``gcp_forwarding_rule`` use :ref:`gcp_compute_global_forwarding_rule <gcp_compute_global_forwarding_rule_module>` or :ref:`gcp_compute_forwarding_rule <gcp_compute_forwarding_rule_module>` instead.
399
-* ``gcp_healthcheck`` use :ref:`gcp_compute_health_check <gcp_compute_health_check_module>`, :ref:`gcp_compute_http_health_check <gcp_compute_http_health_check_module>`, or :ref:`gcp_compute_https_health_check <gcp_compute_https_health_check_module>` instead.
400
-* ``gcp_backend_service`` use :ref:`gcp_compute_backend_service <gcp_compute_backend_service_module>` instead.
401
-* ``gcp_target_proxy`` use :ref:`gcp_compute_target_http_proxy <gcp_compute_target_http_proxy_module>` instead.
402
-* ``gcp_url_map`` use :ref:`gcp_compute_url_map <gcp_compute_url_map_module>` instead.
392
+* ``github_hooks`` use :ref:`github_webhook <ansible_2_8:github_webhook_module>` and :ref:`github_webhook_facts <ansible_2_8:github_webhook_facts_module>` instead.
393
+* ``digital_ocean`` use :ref:`digital_ocean_droplet <ansible_2_8:digital_ocean_droplet_module>` instead.
394
+* ``gce`` use :ref:`gcp_compute_instance <ansible_2_8:gcp_compute_instance_module>` instead.
395
+* ``gcspanner`` use :ref:`gcp_spanner_instance <ansible_2_8:gcp_spanner_instance_module>` and :ref:`gcp_spanner_database <ansible_2_8:gcp_spanner_database_module>` instead.
396
+* ``gcdns_record`` use :ref:`gcp_dns_resource_record_set <ansible_2_8:gcp_dns_resource_record_set_module>` instead.
397
+* ``gcdns_zone`` use :ref:`gcp_dns_managed_zone <ansible_2_8:gcp_dns_managed_zone_module>` instead.
398
+* ``gcp_forwarding_rule`` use :ref:`gcp_compute_global_forwarding_rule <ansible_2_8:gcp_compute_global_forwarding_rule_module>` or :ref:`gcp_compute_forwarding_rule <ansible_2_8:gcp_compute_forwarding_rule_module>` instead.
399
+* ``gcp_healthcheck`` use :ref:`gcp_compute_health_check <ansible_2_8:gcp_compute_health_check_module>`, :ref:`gcp_compute_http_health_check <ansible_2_8:gcp_compute_http_health_check_module>`, or :ref:`gcp_compute_https_health_check <ansible_2_8:gcp_compute_https_health_check_module>` instead.
400
+* ``gcp_backend_service`` use :ref:`gcp_compute_backend_service <ansible_2_8:gcp_compute_backend_service_module>` instead.
401
+* ``gcp_target_proxy`` use :ref:`gcp_compute_target_http_proxy <ansible_2_8:gcp_compute_target_http_proxy_module>` instead.
402
+* ``gcp_url_map`` use :ref:`gcp_compute_url_map <ansible_2_8:gcp_compute_url_map_module>` instead.
403 403
 * ``panos`` use the `Palo Alto Networks Ansible Galaxy role <https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks>`_ instead.
404 404
 
405 405
 
... ...
@@ -453,7 +453,7 @@ Noteworthy module changes
453 453
 * The ``docker_volume`` module has deprecated the returned fact ``docker_container``. The same value is
454 454
   available as the returned variable ``volume``. The returned fact will be removed in Ansible 2.12.
455 455
 
456
-* The ``docker_service`` module was renamed to :ref:`docker_compose <docker_compose_module>`.
456
+* The ``docker_service`` module was renamed to :ref:`docker_compose <ansible_2_8:docker_compose_module>`.
457 457
 * The renamed ``docker_compose`` module used to return one fact per service, named same as the service. A dictionary
458 458
   of these facts is returned as the regular return value ``services``. The returned facts will be removed in
459 459
   Ansible 2.12.
... ...
@@ -117,15 +117,15 @@ Modules removed
117 117
 The following modules no longer exist:
118 118
 
119 119
 * Apstra's ``aos_*`` modules.  See the new modules at  `https://github.com/apstra <https://github.com/apstra>`_.
120
-* ec2_ami_find use :ref:`ec2_ami_facts <ec2_ami_facts_module>` instead.
121
-* kubernetes use :ref:`k8s <k8s_module>` instead.
122
-* nxos_ip_interface use :ref:`nxos_l3_interface <nxos_l3_interface_module>` instead.
123
-* nxos_portchannel use :ref:`nxos_linkagg <nxos_linkagg_module>` instead.
124
-* nxos_switchport use :ref:`nxos_l2_interface <nxos_l2_interface_module>` instead.
125
-* oc use :ref:`k8s <k8s_module>` instead.
126
-* panos_nat_policy use :ref:`panos_nat_rule <panos_nat_rule_module>` instead.
127
-* panos_security_policy use :ref:`panos_security_rule <panos_security_rule_module>` instead.
128
-* vsphere_guest use :ref:`vmware_guest <vmware_guest_module>` instead.
120
+* ec2_ami_find use :ref:`ec2_ami_facts <ansible_2_9:ec2_ami_facts_module>` instead.
121
+* kubernetes use :ref:`k8s <ansible_2_9:k8s_module>` instead.
122
+* nxos_ip_interface use :ref:`nxos_l3_interface <ansible_2_9:nxos_l3_interface_module>` instead.
123
+* nxos_portchannel use :ref:`nxos_linkagg <ansible_2_9:nxos_linkagg_module>` instead.
124
+* nxos_switchport use :ref:`nxos_l2_interface <ansible_2_9:nxos_l2_interface_module>` instead.
125
+* oc use :ref:`k8s <ansible_2_9:k8s_module>` instead.
126
+* panos_nat_policy use :ref:`panos_nat_rule <ansible_2_9:panos_nat_rule_module>` instead.
127
+* panos_security_policy use :ref:`panos_security_rule <ansible_2_9:panos_security_rule_module>` instead.
128
+* vsphere_guest use :ref:`vmware_guest <ansible_2_9:vmware_guest_module>` instead.
129 129
 
130 130
 
131 131
 Deprecation notices
... ...
@@ -51,7 +51,7 @@ Using the ACI modules
51 51
 ---------------------
52 52
 The Ansible ACI modules provide a user-friendly interface to managing your ACI environment using Ansible playbooks.
53 53
 
54
-For instance ensuring that a specific tenant exists, is done using the following Ansible task using module :ref:`aci_tenant <aci_tenant_module>`:
54
+For instance ensuring that a specific tenant exists, is done using the following Ansible task using the aci_tenant module:
55 55
 
56 56
 .. code-block:: yaml
57 57
 
... ...
@@ -60,12 +60,12 @@ For instance ensuring that a specific tenant exists, is done using the following
60 60
         host: my-apic-1
61 61
         username: admin
62 62
         password: my-password
63
-    
63
+
64 64
         tenant: customer-xyz
65 65
         description: Customer XYZ
66 66
         state: present
67 67
 
68
-A complete list of existing ACI modules is available for the latest stable release on the :ref:`list of network modules <network_modules>`. You can also view the `current development version <https://docs.ansible.com/ansible/devel/modules/list_of_network_modules.html#aci>`_.
68
+A complete list of existing ACI modules is available on the content tab of the `ACI collection on Ansible Galaxy <https://galaxy.ansible.com/cisco/aci>`_.
69 69
 
70 70
 If you want to learn how to write your own ACI modules to contribute, look at the :ref:`Developing Cisco ACI modules <aci_dev_guide>` section.
71 71
 
... ...
@@ -81,7 +81,7 @@ A module can also be used to query a specific object.
81 81
         host: my-apic-1
82 82
         username: admin
83 83
         password: my-password
84
-    
84
+
85 85
         tenant: customer-xyz
86 86
         state: query
87 87
       register: my_tenant
... ...
@@ -95,11 +95,11 @@ Or query all objects.
95 95
         host: my-apic-1
96 96
         username: admin
97 97
         password: my-password
98
-    
98
+
99 99
         state: query
100 100
       register: all_tenants
101 101
 
102
-After registering the return values of the :ref:`aci_tenant <aci_tenant_module>` task as shown above, you can access all tenant information from variable ``all_tenants``.
102
+After registering the return values of the aci_tenant task as shown above, you can access all tenant information from variable ``all_tenants``.
103 103
 
104 104
 
105 105
 Running on the controller locally
... ...
@@ -147,7 +147,7 @@ One way to set this up is to add to every task the directive: ``delegate_to: loc
147 147
         host: '{{ ansible_host }}'
148 148
         username: '{{ ansible_user }}'
149 149
         password: '{{ ansible_password }}'
150
-    
150
+
151 151
         state: query
152 152
       delegate_to: localhost
153 153
       register: all_tenants
... ...
@@ -180,7 +180,7 @@ But used tasks do not need anything special added.
180 180
         host: '{{ ansible_host }}'
181 181
         username: '{{ ansible_user }}'
182 182
         password: '{{ ansible_password }}'
183
-    
183
+
184 184
         state: query
185 185
       register: all_tenants
186 186
 
... ...
@@ -352,7 +352,7 @@ You can automate this by using the following Ansible task:
352 352
         host: my-apic-1
353 353
         username: admin
354 354
         password: my-password
355
-    
355
+
356 356
         aaa_user: admin
357 357
         certificate_name: admin
358 358
         certificate: "{{ lookup('file', 'pki/admin.crt') }}"  # This will read the certificate data from a local file
... ...
@@ -406,7 +406,7 @@ Use a text editor to open the private-key. You should have an encrypted cert now
406 406
     45641818198456456489479874513215489484843614848456466655432455488484654848489498
407 407
     ....
408 408
 
409
-Copy and paste the new encrypted cert into your playbook as a new variable. 
409
+Copy and paste the new encrypted cert into your playbook as a new variable.
410 410
 
411 411
 .. code-block:: yaml
412 412
 
... ...
@@ -443,17 +443,17 @@ Using ACI REST with Ansible
443 443
 ---------------------------
444 444
 While already a lot of ACI modules exists in the Ansible distribution, and the most common actions can be performed with these existing modules, there's always something that may not be possible with off-the-shelf modules.
445 445
 
446
-The :ref:`aci_rest <aci_rest_module>` module provides you with direct access to the APIC REST API and enables you to perform any task not already covered by the existing modules. This may seem like a complex undertaking, but you can generate the needed REST payload for any action performed in the ACI web interface effortlessly.
446
+The aci_rest module provides you with direct access to the APIC REST API and enables you to perform any task not already covered by the existing modules. This may seem like a complex undertaking, but you can generate the needed REST payload for any action performed in the ACI web interface effortlessly.
447 447
 
448 448
 
449 449
 Built-in idempotency
450 450
 ....................
451
-Because the APIC REST API is intrinsically idempotent and can report whether a change was made, the :ref:`aci_rest <aci_rest_module>` module automatically inherits both capabilities and is a first-class solution for automating your ACI infrastructure. As a result, users that require more powerful low-level access to their ACI infrastructure don't have to give up on idempotency and don't have to guess whether a change was performed when using the :ref:`aci_rest <aci_rest_module>` module.
451
+Because the APIC REST API is intrinsically idempotent and can report whether a change was made, the aci_rest module automatically inherits both capabilities and is a first-class solution for automating your ACI infrastructure. As a result, users that require more powerful low-level access to their ACI infrastructure don't have to give up on idempotency and don't have to guess whether a change was performed when using the aci_rest module.
452 452
 
453 453
 
454 454
 Using the aci_rest module
455 455
 .........................
456
-The :ref:`aci_rest <aci_rest_module>` module accepts the native XML and JSON payloads, but additionally accepts inline YAML payload (structured like JSON). The XML payload requires you to use a path ending with ``.xml`` whereas JSON or YAML require the path to end with ``.json``.
456
+The aci_rest module accepts the native XML and JSON payloads, but additionally accepts inline YAML payload (structured like JSON). The XML payload requires you to use a path ending with ``.xml`` whereas JSON or YAML require the path to end with ``.json``.
457 457
 
458 458
 When you're making modifications, you can use the POST or DELETE methods, whereas doing just queries require the GET method.
459 459
 
... ...
@@ -466,7 +466,7 @@ For instance, if you would like to ensure a specific tenant exists on ACI, these
466 466
     - aci_rest:
467 467
         host: my-apic-1
468 468
         private_key: pki/admin.key
469
-    
469
+
470 470
         method: post
471 471
         path: /api/mo/uni.xml
472 472
         content: |
... ...
@@ -479,7 +479,7 @@ For instance, if you would like to ensure a specific tenant exists on ACI, these
479 479
     - aci_rest:
480 480
         host: my-apic-1
481 481
         private_key: pki/admin.key
482
-    
482
+
483 483
         method: post
484 484
         path: /api/mo/uni.json
485 485
         content:
... ...
@@ -499,7 +499,7 @@ For instance, if you would like to ensure a specific tenant exists on ACI, these
499 499
     - aci_rest:
500 500
         host: my-apic-1
501 501
         private_key: pki/admin.key
502
-    
502
+
503 503
         method: post
504 504
         path: /api/mo/uni.json
505 505
         content:
... ...
@@ -515,7 +515,7 @@ For instance, if you would like to ensure a specific tenant exists on ACI, these
515 515
     - aci_tenant:
516 516
         host: my-apic-1
517 517
         private_key: pki/admin.key
518
-    
518
+
519 519
         tenant: customer-xyz
520 520
         description: Customer XYZ
521 521
         state: present
... ...
@@ -528,7 +528,7 @@ More information
528 528
 ................
529 529
 Plenty of resources exist to learn about ACI's APIC REST interface, we recommend the links below:
530 530
 
531
-- :ref:`The aci_rest module documentation <aci_rest_module>`
531
+- `The ACI collection on Ansible Galaxy <https://galaxy.ansible.com/cisco/aci>`_
532 532
 - `APIC REST API Configuration Guide <https://www.cisco.com/c/en/us/td/docs/switches/datacenter/aci/apic/sw/2-x/rest_cfg/2_1_x/b_Cisco_APIC_REST_API_Configuration_Guide.html>`_ -- Detailed guide on how the APIC REST API is designed and used, incl. many examples
533 533
 - `APIC Management Information Model reference <https://developer.cisco.com/docs/apic-mim-ref/>`_ -- Complete reference of the APIC object model
534 534
 - `Cisco DevNet Learning Labs about ACI and REST <https://learninglabs.cisco.com/labs/tags/ACI,REST>`_
... ...
@@ -591,7 +591,7 @@ APIC error messages
591 591
 The following error messages may occur and this section can help you understand what exactly is going on and how to fix/avoid them.
592 592
 
593 593
     APIC Error 122: unknown managed object class 'polUni'
594
-        In case you receive this error while you are certain your :ref:`aci_rest <aci_rest_module>` payload and object classes are seemingly correct, the issue might be that your payload is not in fact correct JSON (e.g. the sent payload is using single quotes, rather than double quotes), and as a result the APIC is not correctly parsing your object classes from the payload. One way to avoid this is by using a YAML or an XML formatted payload, which are easier to construct correctly and modify later.
594
+        In case you receive this error while you are certain your aci_rest payload and object classes are seemingly correct, the issue might be that your payload is not in fact correct JSON (e.g. the sent payload is using single quotes, rather than double quotes), and as a result the APIC is not correctly parsing your object classes from the payload. One way to avoid this is by using a YAML or an XML formatted payload, which are easier to construct correctly and modify later.
595 595
 
596 596
 
597 597
     APIC Error 400: invalid data at line '1'. Attributes are missing, tag 'attributes' must be specified first, before any other tag
... ...
@@ -606,7 +606,7 @@ The following error messages may occur and this section can help you understand
606 606
 
607 607
 Known issues
608 608
 ------------
609
-The :ref:`aci_rest <aci_rest_module>` module is a wrapper around the APIC REST API. As a result any issues related to the APIC will be reflected in the use of this module.
609
+The aci_rest module is a wrapper around the APIC REST API. As a result any issues related to the APIC will be reflected in the use of this module.
610 610
 
611 611
 All below issues either have been reported to the vendor, and most can simply be avoided.
612 612
 
... ...
@@ -645,8 +645,8 @@ You will find our roadmap, an overview of open ACI issues and pull-requests, and
645 645
 
646 646
 .. seealso::
647 647
 
648
-   :ref:`List of ACI modules <aci_network_modules>`
649
-       A complete list of supported ACI modules.
648
+   `ACI collection on Ansible Galaxy <https://galaxy.ansible.com/cisco/aci>`_
649
+       View the content tab for a complete list of supported ACI modules.
650 650
    :ref:`Developing Cisco ACI modules <aci_dev_guide>`
651 651
        A walkthough on how to develop new Cisco ACI modules to contribute back.
652 652
    `ACI community <https://github.com/ansible/community/wiki/Network:-ACI>`_