#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2022, Tim Cragg (@timcragg) # 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_aaa_ssh_auth short_description: Manage AAA SSH auth objects (aaa:SshAuth) description: - Manage AAA SSH Auth key configuration on Cisco ACI fabrics. options: aaa_user: description: - Name of an existing AAA user type: str required: true auth_name: description: - Name of the AAA SSH Auth key type: str data: description: - SSH key data type: str 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(aaa_user) must exist before using this module in your playbook. The M(cisco.aci.aci_aaa_user) modules can be used for this. seealso: - name: APIC Management Information Model reference description: More information about the internal APIC class B(aaa:SshAuth). link: https://developer.cisco.com/docs/apic-mim-ref/ author: - Tim Cragg (@timcragg) """ EXAMPLES = r""" - name: Add a new SSH key cisco.aci.aci_aaa_ssh_auth: host: apic username: admin password: SomeSecretPassword aaa_user: my_user auth_name: my_key data: "{{ ssh_key_data_var }}" state: present delegate_to: localhost - name: Remove an SSH key cisco.aci.aci_aaa_ssh_auth: host: apic username: admin password: SomeSecretPassword aaa_user: my_user auth_name: my_key state: absent delegate_to: localhost - name: Query an SSH key cisco.aci.aci_aaa_ssh_auth: host: apic username: admin password: SomeSecretPassword aaa_user: my_user auth_name: my_key state: query delegate_to: localhost register: query_result - name: Query all SSH auth keys under a user cisco.aci.aci_aaa_ssh_auth: host: apic username: admin password: SomeSecretPassword aaa_user: my_user 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: '' 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( aaa_user=dict(type="str", required=True), auth_name=dict(type="str"), data=dict(type="str"), state=dict(type="str", default="present", choices=["absent", "present", "query"]), ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, required_if=[ ["state", "absent", ["auth_name"]], ["state", "present", ["auth_name", "data"]], ], ) aaa_user = module.params.get("aaa_user") auth_name = module.params.get("auth_name") data = module.params.get("data") state = module.params.get("state") aci = ACIModule(module) aci.construct_url( root_class=dict( aci_class="aaaUser", aci_rn="userext/user-{0}".format(aaa_user), module_object=aaa_user, target_filter={"name": aaa_user}, ), subclass_1=dict( aci_class="aaaSshAuth", aci_rn="sshauth-{0}".format(auth_name), module_object=auth_name, target_filter={"name": auth_name}, ), ) aci.get_existing() if state == "present": aci.payload( aci_class="aaaSshAuth", class_config=dict(name=auth_name, data=data), ) aci.get_diff(aci_class="aaaSshAuth") aci.post_config() elif state == "absent": aci.delete_config() aci.exit_json() if __name__ == "__main__": main()