#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2023, Gaspard Micol (@gmicol) # 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_firmware_group_node short_description: Manage firmware group nodes (fabric:NodeBlk) description: - This module adds/deletes a node to the firmware group. options: group: description: - This is the name of the firmware group. type: str node: description: - The node to be added to the firmware group. - The value equals the NodeID. 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 default: present choices: [ absent, present, query ] 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 seealso: - module: cisco.aci.aci_firmware_group - name: APIC Management Information Model reference description: More information about the internal APIC class B(l3ext:Out). link: https://developer.cisco.com/docs/apic-mim-ref/ author: - Steven Gerhart (@sgerhart) - Gaspard Micol (@gmicol) """ EXAMPLES = r""" - name: Add a firmware group node cisco.aci.aci_firmware_group_node: host: apic username: admin password: SomeSecretPassword group: fmgroup node: 1001 state: present delegate_to: localhost - name: Remove a firmware group node cisco.aci.aci_firmware_group_node: host: apic username: admin password: SomeSecretPassword group: fmgroup node: 1001 state: absent delegate_to: localhost - name: Query all firmware groups nodes cisco.aci.aci_firmware_group_node: host: apic username: admin password: SomeSecretPassword state: query delegate_to: localhost register: query_result - name: Query a specific firmware group node cisco.aci.aci_firmware_group_node: host: apic username: admin password: SomeSecretPassword group: fmgroup node: 1001 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_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec, aci_annotation_spec from ansible.module_utils.basic import AnsibleModule def main(): argument_spec = aci_argument_spec() argument_spec.update(aci_annotation_spec()) argument_spec.update( group=dict(type="str"), # Not required for querying all objects node=dict(type="str"), 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", ["node", "group"]], ["state", "present", ["node", "group"]], ], ) state = module.params.get("state") group = module.params.get("group") node = module.params.get("node") name_alias = module.params.get("name_alias") block_name = None if node is not None: block_name = "blk{0}-{0}".format(node) aci = ACIModule(module) aci.construct_url( root_class=dict( aci_class="firmwareFwGrp", aci_rn="fabric/fwgrp-{0}".format(group), target_filter={"name": group}, module_object=group, ), subclass_1=dict( aci_class="fabricNodeBlk", aci_rn="nodeblk-blk{0}-{0}".format(node), target_filter={"name": block_name}, module_object=node, ), ) aci.get_existing() if state == "present": aci.payload( aci_class="fabricNodeBlk", class_config=dict( from_=node, to_=node, nameAlias=name_alias, ), ) aci.get_diff(aci_class="fabricNodeBlk") aci.post_config() elif state == "absent": aci.delete_config() aci.exit_json() if __name__ == "__main__": main()