mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Rename MSC modules to MSO nomenclature (#50959)
* msc_tenant: improve docs * Rename MSC modules to MSO * Rename MSC-related objects to MSO nomenclature * Add missing doc fragments
This commit is contained in:
Dag Wieers
GitHub
parent
7a1ceb6988
commit
a79441ca30
21 changed files with 493 additions and 491 deletions
260
lib/ansible/modules/network/aci/mso_site.py
Normal file
260
lib/ansible/modules/network/aci/mso_site.py
Normal file
|
|
@ -0,0 +1,260 @@
|
|||
#!/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': 'community'}
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: mso_site
|
||||
short_description: Manage sites
|
||||
description:
|
||||
- Manage sites on Cisco ACI Multi-Site.
|
||||
author:
|
||||
- Dag Wieers (@dagwieers)
|
||||
version_added: '2.8'
|
||||
options:
|
||||
apic_password:
|
||||
description:
|
||||
- The password for the APICs.
|
||||
type: str
|
||||
required: yes
|
||||
apic_site_id:
|
||||
description:
|
||||
- The site ID of the APICs.
|
||||
type: str
|
||||
required: yes
|
||||
apic_username:
|
||||
description:
|
||||
- The username for the APICs.
|
||||
type: str
|
||||
required: yes
|
||||
default: admin
|
||||
site_id:
|
||||
description:
|
||||
- The ID of the site.
|
||||
type: str
|
||||
site:
|
||||
description:
|
||||
- The name of the site.
|
||||
- Alternative to the name, you can use C(site_id).
|
||||
type: str
|
||||
required: yes
|
||||
aliases: [ name, site_name ]
|
||||
labels:
|
||||
description:
|
||||
- The labels for this site.
|
||||
- Labels that do not already exist will be automatically created.
|
||||
type: list
|
||||
location:
|
||||
description:
|
||||
- Location of the site.
|
||||
suboptions:
|
||||
latitude:
|
||||
description:
|
||||
- The latitude of the location of the site.
|
||||
type: float
|
||||
longitude:
|
||||
description:
|
||||
- The longititude of the location of the site.
|
||||
type: float
|
||||
urls:
|
||||
description:
|
||||
- A list of URLs to reference the APICs.
|
||||
type: list
|
||||
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: mso
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Add a new site
|
||||
mso_site:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
site: north_europe
|
||||
description: North European Datacenter
|
||||
apic_username: mso_admin
|
||||
apic_password: AnotherSecretPassword
|
||||
apic_site_id: 12
|
||||
urls:
|
||||
- 10.2.3.4
|
||||
- 10.2.4.5
|
||||
- 10.3.5.6
|
||||
labels:
|
||||
- NEDC
|
||||
- Europe
|
||||
- Diegem
|
||||
location:
|
||||
latitude: 50.887318
|
||||
longitude: 4.447084
|
||||
state: present
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Remove a site
|
||||
mso_site:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
site: north_europe
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Query a site
|
||||
mso_site:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
site: north_europe
|
||||
state: query
|
||||
delegate_to: localhost
|
||||
register: query_result
|
||||
|
||||
- name: Query all sites
|
||||
mso_site:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
state: query
|
||||
delegate_to: localhost
|
||||
register: query_result
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.network.aci.mso import MSOModule, mso_argument_spec, issubset
|
||||
|
||||
|
||||
def main():
|
||||
location_arg_spec = dict(
|
||||
latitude=dict(type='float'),
|
||||
longitude=dict(type='float'),
|
||||
)
|
||||
|
||||
argument_spec = mso_argument_spec()
|
||||
argument_spec.update(
|
||||
apic_password=dict(type='str', no_log=True),
|
||||
apic_site_id=dict(type='str'),
|
||||
apic_username=dict(type='str', default='admin'),
|
||||
labels=dict(type='list'),
|
||||
location=dict(type='dict', options=location_arg_spec),
|
||||
site=dict(type='str', required=False, aliases=['name', 'site_name']),
|
||||
site_id=dict(type='str', required=False),
|
||||
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
||||
urls=dict(type='list'),
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_if=[
|
||||
['state', 'absent', ['site']],
|
||||
['state', 'present', ['apic_site_id', 'site']],
|
||||
],
|
||||
)
|
||||
|
||||
apic_username = module.params['apic_username']
|
||||
apic_password = module.params['apic_password']
|
||||
apic_site_id = module.params['apic_site_id']
|
||||
site = module.params['site']
|
||||
site_id = module.params['site_id']
|
||||
location = module.params['location']
|
||||
if location is not None:
|
||||
latitude = module.params['location']['latitude']
|
||||
longitude = module.params['location']['longitude']
|
||||
state = module.params['state']
|
||||
urls = module.params['urls']
|
||||
|
||||
mso = MSOModule(module)
|
||||
|
||||
path = 'sites'
|
||||
|
||||
# Convert labels
|
||||
labels = mso.lookup_labels(module.params['labels'], 'site')
|
||||
|
||||
# Query for mso.existing object(s)
|
||||
if site_id is None and site is None:
|
||||
mso.existing = mso.query_objs(path)
|
||||
elif site_id is None:
|
||||
mso.existing = mso.get_obj(path, name=site)
|
||||
if mso.existing:
|
||||
site_id = mso.existing['id']
|
||||
elif site is None:
|
||||
mso.existing = mso.get_obj(path, id=site_id)
|
||||
else:
|
||||
mso.existing = mso.get_obj(path, id=site_id)
|
||||
existing_by_name = mso.get_obj(path, name=site)
|
||||
if existing_by_name and site_id != existing_by_name['id']:
|
||||
mso.fail_json(msg="Provided site '{0}' with id '{1}' does not match existing id '{2}'.".format(site, site_id, existing_by_name['id']))
|
||||
|
||||
# If we found an existing object, continue with it
|
||||
if site_id:
|
||||
path = 'sites/{id}'.format(id=site_id)
|
||||
|
||||
if state == 'query':
|
||||
pass
|
||||
|
||||
elif state == 'absent':
|
||||
mso.previous = mso.existing
|
||||
if mso.existing:
|
||||
if module.check_mode:
|
||||
mso.existing = {}
|
||||
else:
|
||||
mso.existing = mso.request(path, method='DELETE', qs=dict(force='true'))
|
||||
|
||||
elif state == 'present':
|
||||
mso.previous = mso.existing
|
||||
|
||||
payload = dict(
|
||||
apicSiteId=apic_site_id,
|
||||
id=site_id,
|
||||
name=site,
|
||||
urls=urls,
|
||||
labels=labels,
|
||||
username=apic_username,
|
||||
password=apic_password,
|
||||
)
|
||||
|
||||
if location is not None:
|
||||
payload['location'] = dict(
|
||||
lat=latitude,
|
||||
long=longitude,
|
||||
)
|
||||
|
||||
mso.sanitize(payload, collate=True)
|
||||
|
||||
if mso.existing:
|
||||
if not issubset(mso.sent, mso.existing):
|
||||
if module.check_mode:
|
||||
mso.existing = mso.proposed
|
||||
else:
|
||||
mso.existing = mso.request(path, method='PUT', data=mso.sent)
|
||||
else:
|
||||
if module.check_mode:
|
||||
mso.existing = mso.proposed
|
||||
else:
|
||||
mso.existing = mso.request(path, method='POST', data=mso.sent)
|
||||
|
||||
if 'password' in mso.existing:
|
||||
mso.existing['password'] = '******'
|
||||
|
||||
mso.exit_json()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue