mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-06 09:00:58 +02:00
276 lines
7.3 KiB
Python
276 lines
7.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2018, Dag Wieers (dagwieers) <dag@wieers.com>
|
|
# GNU General Public License v3.0+ (see COPYING 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_firmware_source
|
|
short_description: Manage firmware image sources (firmware:OSource)
|
|
description:
|
|
- Manage firmware image sources on Cisco ACI fabrics.
|
|
author:
|
|
- Dag Wieers (@dagwieers)
|
|
version_added: '2.5'
|
|
notes:
|
|
- More information about the internal APIC class B(firmware:OSource) from
|
|
L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
|
|
options:
|
|
source:
|
|
description:
|
|
- The identifying name for the outside source of images, such as an HTTP or SCP server.
|
|
required: yes
|
|
aliases: [ name, source_name ]
|
|
polling_interval:
|
|
description:
|
|
- Polling interval in minutes.
|
|
type: int
|
|
url_protocol:
|
|
description:
|
|
- The Firmware download protocol.
|
|
choices: [ http, local, scp, usbkey ]
|
|
default: scp
|
|
aliases: [ url_proto ]
|
|
url:
|
|
description:
|
|
The firmware URL for the image(s) on the source.
|
|
url_password:
|
|
description:
|
|
The Firmware password or key string.
|
|
url_username:
|
|
description:
|
|
The username for the source.
|
|
state:
|
|
description:
|
|
- Use C(present) or C(absent) for adding or removing.
|
|
- Use C(query) for listing an object or multiple objects.
|
|
choices: [ absent, present, query ]
|
|
default: present
|
|
extends_documentation_fragment: aci
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Add firmware source
|
|
aci_firmware_source:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
source: aci-msft-pkg-3.1.1i.zip
|
|
url: foo.bar.cisco.com/download/cisco/aci/aci-msft-pkg-3.1.1i.zip
|
|
url_protocol: http
|
|
state: present
|
|
delegate_to: localhost
|
|
|
|
- name: Remove firmware source
|
|
aci_firmware_source:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
source: aci-msft-pkg-3.1.1i.zip
|
|
state: absent
|
|
delegate_to: localhost
|
|
|
|
- name: Query a specific firmware source
|
|
aci_firmware_source:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
source: aci-msft-pkg-3.1.1i.zip
|
|
state: query
|
|
delegate_to: localhost
|
|
register: query_result
|
|
|
|
- name: Query all firmware sources
|
|
aci_firmware_source:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
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: string
|
|
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: string
|
|
sample: ?rsp-prop-include=config-only
|
|
method:
|
|
description: The HTTP method used for the request to the APIC
|
|
returned: failure or debug
|
|
type: string
|
|
sample: POST
|
|
response:
|
|
description: The HTTP response from the APIC
|
|
returned: failure or debug
|
|
type: string
|
|
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: string
|
|
sample: https://10.11.12.13/api/mo/uni/tn-production.json
|
|
'''
|
|
|
|
|
|
from ansible.module_utils.network.aci.aci import ACIModule, aci_argument_spec
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def main():
|
|
argument_spec = aci_argument_spec()
|
|
argument_spec.update(
|
|
source=dict(type='str', aliases=['name', 'source_name']), # Not required for querying all objects
|
|
polling_interval=dict(type='int'),
|
|
url=dict(type='str'),
|
|
url_username=dict(type='str'),
|
|
url_password=dict(type='str', no_log=True),
|
|
url_protocol=dict(type='str', default='scp', choices=['http', 'local', 'scp', 'usbkey'], aliases=['url_proto']),
|
|
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
|
)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec,
|
|
supports_check_mode=True,
|
|
required_if=[
|
|
['state', 'absent', ['source']],
|
|
['state', 'present', ['url_protocol', 'source', 'url']],
|
|
],
|
|
)
|
|
|
|
polling_interval = module.params['polling_interval']
|
|
url_protocol = module.params['url_protocol']
|
|
state = module.params['state']
|
|
source = module.params['source']
|
|
url = module.params['url']
|
|
url_password = module.params['url_password']
|
|
url_username = module.params['url_username']
|
|
|
|
aci = ACIModule(module)
|
|
aci.construct_url(
|
|
root_class=dict(
|
|
aci_class='firmwareOSource',
|
|
aci_rn='fabric/fwrepop',
|
|
module_object=source,
|
|
target_filter={'name': source},
|
|
),
|
|
)
|
|
aci.get_existing()
|
|
|
|
if state == 'present':
|
|
aci.payload(
|
|
aci_class='firmwareOSource',
|
|
class_config=dict(
|
|
name=source,
|
|
url=url,
|
|
password=url_password,
|
|
pollingInterval=polling_interval,
|
|
proto=url_protocol,
|
|
user=url_username,
|
|
),
|
|
)
|
|
|
|
aci.get_diff(aci_class='firmwareOSource')
|
|
|
|
aci.post_config()
|
|
|
|
elif state == 'absent':
|
|
aci.delete_config()
|
|
|
|
aci.exit_json()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|