path: root/ansible_collections/cisco/aci/plugins/modules/aci_key_policy.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright: (c) 2023, Gaspard Micol (@gmicol) <gmicol@cisco.com>
# 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": "community"}

DOCUMENTATION = r"""
---
module: aci_key_policy
short_description: Manage Key Policy (fv:KeyPol)
description:
- Manage Key Policies for KeyChain Policies on Cisco ACI fabrics.
options:
  tenant:
    description:
    - The name of an existing tenant.
    type: str
    aliases: [ tenant_name ]
  keychain_policy:
    description:
    - The name of an existing keychain policy.
    type: str
    aliases: [ keychain_policy_name ]
  id:
    description:
    - The object identifier.
    type: int
  start_time:
    description:
    - The start time of the key policy.
    - The APIC defaults to C(now) when unset during creation.
    - The format is YYYY-MM-DD HH:MM:SS
    type: str
  end_time:
    description:
    - The end time of the key policy.
    - The APIC defaults to C(infinite) when unset during creation.
    - The format is YYYY-MM-DD HH:MM:SS
    type: str
  pre_shared_key:
    description:
    - The pre-shared authentifcation key.
    - When using I(pre_shared_key) this module will always show as C(changed) as the module cannot know what the currently configured key is.
    type: str
  description:
    description:
    - The description for the keychain policy.
    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
extends_documentation_fragment:
- cisco.aci.aci
- cisco.aci.annotation
- cisco.aci.owner

notes:
- The C(tenant) and C(keychain_policy) must exist before using this module in your playbook.
  The M(cisco.aci.aci_tenant) and M(cisco.aci.aci_keychain_policy) can be used for this.
seealso:
- module: cisco.aci.aci_tenant
- module: cisco.aci.aci_keychain_policy
- name: APIC Management Information Model reference
  description: More information about the internal APIC classes
  link: https://developer.cisco.com/docs/apic-mim-ref/
author:
- Gaspard Micol (@gmicol)
"""

EXAMPLES = r"""
- name: Add a new key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    start_time: now
    end_time: infinite
    pre_shared_key: my_password
    state: present
  delegate_to: localhost

- name: Delete an key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    state: absent
  delegate_to: localhost

- name: Query an key policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    id: 1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all key policies in my_keychain_policy
  cisco.aci.aci_key_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    keychain_policy: my_keychain_policy
    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


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"]),
        keychain_policy=dict(type="str", aliases=["keychain_policy_name"], no_log=False),
        id=dict(type="int"),
        start_time=dict(type="str"),
        end_time=dict(type="str"),
        pre_shared_key=dict(type="str", no_log=True),
        description=dict(type="str", aliases=["descr"]),
        state=dict(type="str", default="present", choices=["absent", "present", "query"]),
    )

    module = AnsibleModule(
        argument_spec=argument_spec,
        supports_check_mode=True,
        required_if=[
            ["state", "absent", ["tenant", "keychain_policy", "id"]],
            ["state", "present", ["tenant", "keychain_policy", "id"]],
        ],
    )

    tenant = module.params.get("tenant")
    keychain_policy = module.params.get("keychain_policy")
    id = module.params.get("id")
    start_time = module.params.get("start_time")
    end_time = module.params.get("end_time")
    pre_shared_key = module.params.get("pre_shared_key")
    description = module.params.get("description")
    state = module.params.get("state")

    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="fvKeyChainPol",
            aci_rn="keychainp-{0}".format(keychain_policy),
            module_object=keychain_policy,
            target_filter={"name": keychain_policy},
        ),
        subclass_2=dict(
            aci_class="fvKeyPol",
            aci_rn="keyp-{0}".format(id),
            module_object=id,
            target_filter={"id": id},
        ),
    )

    aci.get_existing()

    if state == "present":
        class_config = dict(
            id=id,
            startTime=start_time,
            endTime=end_time,
            descr=description,
        )
        if pre_shared_key is not None:
            class_config.update(preSharedKey=pre_shared_key)

        aci.payload(
            aci_class="fvKeyPol",
            class_config=class_config,
        )

        aci.get_diff(aci_class="fvKeyPol")

        aci.post_config()

    elif state == "absent":
        aci.delete_config()

    aci.exit_json()


if __name__ == "__main__":
    main()