[minor_change] Add aci_bgp_timers_policy and aci_bgp_best_path_policy…

… as new modules.

plugins/modules/aci_bgp_best_path_policy.py

@@ -0,0 +1,294 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2023, Gaspard Micol (@gmicol) <[email protected]>
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {"metadata_version": "1.1", "status": ["preview"], "supported_by": "certified"}
+
+DOCUMENTATION = r"""
+---
+module: aci_l3out_logical_node_profile
+short_description: Manage BGP Best Path policy (bgp:BestPathCtrlPol)
+description:
+- Manage BGP Best Path policies for Tenants on Cisco ACI fabrics.
+options:
+  tenant:
+    description:
+    - The name of an existing tenant.
+    type: str
+    aliases: [ tenant_name ]
+  bgp_best_path_policy:
+    description:
+    - The name of the best path policy.
+    type: str
+    aliases: [ bgp_best_path_policy_name, name ]
+  best_path_control:
+    description:
+    - The option to enable/disable to relax AS-Path restriction when choosing multipaths.
+    - When enabled, allow load sharing across providers with different AS paths.
+    type: str
+    choices: [enable, disable]
+    aliases: [as_path_control]
+  description:
+    description:
+    - Description for the bgp protocol profile.
+    type: str
+    aliases: [ descr ]
+  state:
+    description:
+    - Use C(present) or C(absent) for adding or removing.
+    - Use C(query) for listing an object or multiple objects.
+    type: str
+    choices: [ absent, present, query ]
+    default: present
+  name_alias:
+    description:
+    - The alias for the current object. This relates to the nameAlias field in ACI.
+    type: str
+extends_documentation_fragment:
+- cisco.aci.aci
+- cisco.aci.annotation
+- cisco.aci.owner
+
+notes:
+- The C(tenant) used must exist before using this module in your playbook.
+  The M(cisco.aci.aci_tenant) module can be used for this.
+seealso:
+- module: cisco.aci.aci_tenant
+- name: APIC Management Information Model reference
+  description: More information about the internal APIC class B(bgp:BestPathCtrlPol).
+  link: https://developer.cisco.com/docs/apic-mim-ref/
+author:
+- Dag Wieers (@dagwieers)
+"""
+
+EXAMPLES = r"""
+- name: Create a l3out route tag policy
+  cisco.aci.aci_l3out_route_tag_policy:
+    host: apic
+    username: admin
+    password: SomeSecretPassword
+    tag: 1000
+    bgp_protocol_profile: my_route_tag_policy
+    tenant: production
+    state: present
+  delegate_to: localhost
+
+- name: Delete a l3out route tag policy
+  cisco.aci.aci_l3out_route_tag_policy:
+    host: apic
+    username: admin
+    password: SomeSecretPassword
+    bgp_protocol_profile: my_route_tag_policy
+    tenant: production
+    state: absent
+  delegate_to: localhost
+
+- name: Query all l3out route tag policies
+  cisco.aci.aci_l3out_route_tag_policy:
+    host: apic
+    username: admin
+    password: SomeSecretPassword
+    state: query
+  delegate_to: localhost
+  register: query_result
+
+- name: Query a specific l3out route tag policy
+  cisco.aci.aci_l3out_route_tag_policy:
+    host: apic
+    username: admin
+    password: SomeSecretPassword
+    bgp_protocol_profile: my_route_tag_policy
+    tenant: production
+    state: query
+  delegate_to: localhost
+  register: query_result
+"""
+
+RETURN = r"""
+current:
+  description: The existing configuration from the APIC after the module has finished
+  returned: success
+  type: list
+  sample:
+    [
+        {
+            "fvTenant": {
+                "attributes": {
+                    "descr": "Production environment",
+                    "dn": "uni/tn-production",
+                    "name": "production",
+                    "nameAlias": "",
+                    "ownerKey": "",
+                    "ownerTag": ""
+                }
+            }
+        }
+    ]
+error:
+  description: The error information as returned from the APIC
+  returned: failure
+  type: dict
+  sample:
+    {
+        "code": "122",
+        "text": "unknown managed object class foo"
+    }
+raw:
+  description: The raw output returned by the APIC REST API (xml or json)
+  returned: parse error
+  type: str
+  sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>'
+sent:
+  description: The actual/minimal configuration pushed to the APIC
+  returned: info
+  type: list
+  sample:
+    {
+        "fvTenant": {
+            "attributes": {
+                "descr": "Production environment"
+            }
+        }
+    }
+previous:
+  description: The original configuration from the APIC before the module has started
+  returned: info
+  type: list
+  sample:
+    [
+        {
+            "fvTenant": {
+                "attributes": {
+                    "descr": "Production",
+                    "dn": "uni/tn-production",
+                    "name": "production",
+                    "nameAlias": "",
+                    "ownerKey": "",
+                    "ownerTag": ""
+                }
+            }
+        }
+    ]
+proposed:
+  description: The assembled configuration from the user-provided parameters
+  returned: info
+  type: dict
+  sample:
+    {
+        "fvTenant": {
+            "attributes": {
+                "descr": "Production environment",
+                "name": "production"
+            }
+        }
+    }
+filter_string:
+  description: The filter string used for the request
+  returned: failure or debug
+  type: str
+  sample: ?rsp-prop-include=config-only
+method:
+  description: The HTTP method used for the request to the APIC
+  returned: failure or debug
+  type: str
+  sample: POST
+response:
+  description: The HTTP response from the APIC
+  returned: failure or debug
+  type: str
+  sample: OK (30 bytes)
+status:
+  description: The HTTP status from the APIC
+  returned: failure or debug
+  type: int
+  sample: 200
+url:
+  description: The HTTP url used for the request to the APIC
+  returned: failure or debug
+  type: str
+  sample: https://10.11.12.13/api/mo/uni/tn-production.json
+"""
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec, aci_annotation_spec, aci_owner_spec
+
+BEST_PATH_CONTROL_MAPPING = dict(enable="asPathMultipathRelax", disable="defaultValue")
+
+
+def main():
+    argument_spec = aci_argument_spec()
+    argument_spec.update(aci_annotation_spec())
+    argument_spec.update(aci_owner_spec())
+    argument_spec.update(
+        tenant=dict(type="str", aliases=["tenant_name"]),  # Not required for querying all objects
+        bgp_best_path_policy=dict(type="str", aliases=["bgp_best_path_policy_name", "name"]),  # Not required for querying all objects
+        best_path_control=dict(type="str", choices=["enable", "disable"], aliases=["as_path_control"]),
+        description=dict(type="str", aliases=["descr"]),
+        state=dict(type="str", default="present", choices=["absent", "present", "query"]),
+        name_alias=dict(type="str"),
+    )
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=[
+            ["state", "absent", ["bgp_best_path_policy", "tenant"]],
+            ["state", "present", ["bgp_best_path_policy", "tenant"]],
+        ],
+    )
+
+    bgp_best_path_policy = module.params.get("bgp_best_path_policy")
+    best_path_control = BEST_PATH_CONTROL_MAPPING.get(module.params.get("best_path_control"))
+    description = module.params.get("description")
+    state = module.params.get("state")
+    tenant = module.params.get("tenant")
+    name_alias = module.params.get("name_alias")
+
+    aci = ACIModule(module)
+
+    aci.construct_url(
+        root_class=dict(
+            aci_class="fvTenant",
+            aci_rn="tn-{0}".format(tenant),
+            module_object=tenant,
+            target_filter={"name": tenant},
+        ),
+        subclass_1=dict(
+            aci_class="bgpBestPathCtrlPol",
+            aci_rn="bestpath-{0}".format(bgp_best_path_policy),
+            module_object=bgp_best_path_policy,
+            target_filter={"name": bgp_best_path_policy},
+        ),
+    )
+
+    aci.get_existing()
+
+    if state == "present":
+        aci.payload(
+            aci_class="bgpBestPathCtrlPol",
+            class_config=dict(
+                name=bgp_best_path_policy,
+                ctrl=best_path_control,
+                descr=description,
+                nameAlias=name_alias,
+            ),
+        )
+
+        aci.get_diff(aci_class="bgpBestPathCtrlPol")
+
+        aci.post_config()
+
+    elif state == "absent":
+        aci.delete_config()
+
+    aci.exit_json()
+
+
+if __name__ == "__main__":
+    main()