214 Commits (8b1a934f1c3c0f42c091be4ab72f54976ce94cbf)

Author	SHA1	Message	Date
Sandra McCann	f56c3fdc89	add link to AWS module details (#53126) ... * add link to AWS module details (in 2.7 docs to stable-2.7 branch)	6 years ago
Dag Wieers	a22f46bacf	Docs: Add a "seealso" section to the module docs (#45949) ... * Docs: Add a separate "seealso" section to the module docs to list related modules and/or related references. This clears up the notes section for things that are actual notes. So you can add a section in your module documentation and four types of references are possible. seealso: # Reference by module name - module: aci_tenant # Reference by module name, including description - module: aci_tenant description: ACI module to create tenants on a Cisco ACI fabric. # Reference by rST documentation anchor - ref: aci_guide description: Detailed information on how to manage your ACI infrastructure using Ansible. # Reference by Internet resource - name: APIC Management Information Model reference description: Complete reference of the APIC object model. link: https://developer.cisco.com/docs/apic-mim-ref/ This PR also includes: - Implements ansible-doc support - Implements schema support for the seealso options - Updates to the development documentation - Rename filter convert_symbols_to_format to rst_ify, cfr the existing html_ify and tty_ify filters - This makes the existing template a lot easier to read and fixes the confusion I had myself rereading the template (again). - We fixed the possible suboption types (which was limited to 'bool' only) * Use latest stable instead of devel docs (cherry picked from commit baf0ad2309)	6 years ago
Matt Clay	7a0e86551d	Support skip of platforms by version in tests. (#48826) ... * Support skip of platforms by version in tests. Previously a remote platform could be skipped completely using the alias: `skip/{platform}` such as `skip/rhel` Now a specific platform version can be skipped using the alias: `skip/{platform}{version}` such as `skip/rhel7.6` This feature is available for platforms specified with the `--remote` option. * Add skip by version to the docs. (cherry picked from commit 8066acc90c)	6 years ago
Matt Martz	edae7b0524	[stable-2.7] Prevent metadata changes in a stable branch (#48994) (#49131) ... * [stable-2.7] Prevent metadata changes in a stable branch (#48994) (cherry picked from commit 7287d39) Co-authored-by: Matt Martz <matt@sivel.net> * Fix metadata comparison	6 years ago
Alicia Cozine	86eb3b5b98	adds stub API docs in a single file (#46663) ... * adds stub API docs in a single file (cherry picked from commit 9764f32513)	6 years ago
Sloane Hertel	68aa3e24a8	cherrypick for #46786	6 years ago
John R Barker	39e959eb0c	[stable-2.7] bulk docs update (#47828) ... * Document all Working Group, email lists and IRC channels (#47615) (cherry picked from commit 749af9fd22) * Docs: No need to follow up on backport PRs (#47616) (cherry picked from commit 166e84b9c4) * Tidy up Contributors Docs (#47619) (cherry picked from commit 72359a10e6) * Correct AWX community link (#47742) (cherry picked from commit d189e58f63) * ansible-lint and molecule part of Red Hat (#47826) (cherry picked from commit 4572d9ccd7)	6 years ago
John R Barker	6cfdd9f466	Add docs about contributing to docs (#46481) (#47658) ... * adds page on community contributions to docs (cherry picked from commit 4219d25fc7)	6 years ago
Matt Clay	7ce940cb41	Add symlinks sanity test. (#46467) ... * Add symlinks sanity test. * Replace legacy test symlinks with actual content. * Remove dir symlink from template_jinja2_latest. * Update import test to use generated library dir. * Fix copy test symlink setup. (cherry picked from commit e2b6047514)	6 years ago
Alicia Cozine	649403c3a1	yes, we do run validate_modules in Shippable (#46280) (#46283) ... (cherry picked from commit 66eb5681f4)	6 years ago
Jordan Borean	7cce4dfbb0	add skip/docker alias to skip tests when running on Docker (#45955) ... * add skip/docker alias to skip tests when running on Docker * changed warning message wording (cherry picked from commit 27c10fa502)	6 years ago
Simon Metzger	8f93a0ec67	Update developing_modules_general_aci.rst (#46042)	6 years ago
Sandra McCann	ceb474bb9e	[WIP] Backport/2.7/batch port (#45859) ... Batch of docs backports: * docs: Clarify include_task v import_tasks with conditionals (#43856) (cherry picked from commit 6be42a2a0e) * Add single quotes around package name (#45152) (cherry picked from commit 0d81386144) * prefer ansible_facts namespace and dict notation (#44980) (cherry picked from commit 44510448b0) * fix cherrypick conflict - scenario_guides * Update implicit_localhost.rst (#45455) (cherry picked from commit f68cd1acc6) * updated fbsd install instructions (#45309) (cherry picked from commit e9c2695ce7) * Change "Defaulting Undefined Variables" (#41379) (cherry picked from commit e35c4be1c1) * adds license details to dev guide pages (#45574) (cherry picked from commit 6e68d77f6d) * FAQ: fix a typo, add link to 'vars' lookup (#42412) (cherry picked from commit 95649dc793) * Fix link and toctree (#45595) (cherry picked from commit 6999bf318f) * Improve the local toctree (and title) (#45590) (cherry picked from commit afea00fa9f) * Add undocumented configuration parameter and explain in porting guide (#36059) (cherry picked from commit a892a6ef03) * Simplify PPA installation for Ubuntu (#45690) (cherry picked from commit 78e9f452a5) * adding git+ssh uri scheme (#36025) (cherry picked from commit 84a4257774) * Add workaround for non-standard kerberos environments (#41465) (cherry picked from commit 4e532e0ad9) * Restore license agreement (#45809) (cherry picked from commit f430f60541) * partial cherry-pick - lenovo doc update PR 45483	6 years ago
Dag Wieers	23f70d9745	Backport of 45588 (#45670)	6 years ago
Alicia Cozine	1301d4edc8	rewrite of the developer guide, part 1 (#45179) (#45349) ... (cherry picked from commit 9a76441c02)	6 years ago
Brian Coca	893d59fabe	updated guides to avoid connection: local (#44227) ... - want they really need is `delegate_to: localhost` - also reduced 'local_action' usage in favor of same	6 years ago
Donghyun Kang	5fecf8baab	doc: fixed typo (#44685)	6 years ago
Toshio Kuratomi	68c60ad307	Change validate-modules for removed modules ... Removed modules now don't have documentation. Need to account for that when checking them in validte-modules	6 years ago
Andreas Olsson	00e5123e4c	Update documentation based on 301 permanent redirects (#43675)	6 years ago
Toshio Kuratomi	da26ba3760	Documentatin fixes	6 years ago
Toshio Kuratomi	c4951cce0b	Exorcise Python-2.6	6 years ago
Will Smith	2de692348f	change raising errors example to raise error (#43664) ... Example instantiates an AnsibleError which derives from Exception but doesn't actually raise it like intended. This is misleading as it's not clear without examining the code for AnsibleError to know that it's not some function which would raise the exception automatically.	6 years ago
Andreas Olsson	1a11cecaef	Prefer https:// links in the docs site ... All the changed urls are availible by way of https://. Most of them already redirect.	6 years ago
Matt Martz	01c0446cb5	Add AnsibleModule signature schema, and fix associated issues (#43512)	6 years ago
Matt Clay	4e489d1be8	Update Shippable integration test groups. (#43118) ... * Update Shippable integration test groups. * Update integration test group aliases. * Rebalance AWS and Azure tests with extra group. * Rebalance Windows tests with another group.	6 years ago
Brian Coca	a37f27a243	removed note from already removed 1.x api comment ... fixes #39888	6 years ago
Sachidananda Urs	fecda03066	Fix typos in documentation (#42406) ... Fix typos in unit test documentation Fixes: #42405	6 years ago
Brian Coca	475abc0af7	inventory plugin docs (#42022) ... * inventory plugin docs * added set options * minor wording and formatting fixes * changed headers to std as per #35520, also added to main readme * unified inventory plugin devel, referenced from generic plugin dev * fixed typos and update as per feedback	6 years ago
John R Barker	6366df700d	Document module links (#42308)	6 years ago
John R Barker	d962611528	Allow documentation of module options type (#42285) ... * Allow documentation of module options Pass through the `type` of a modules option so it's displayed on the html module docs * docs	6 years ago
Troy Murray	15ce7c5bab	change OS X to macOS (#41294) ... * change OS X to macOS <!--- Your description here --> +label: docsite_pr * Update all Mac OS X references to be macOS * Drop extra Mac	7 years ago
Andrea Tartaglia	a342538aba	Add shell out checks (#41545) ... * Added error codes for shell_out checks * Added ignore lines for allowed Modules * Added shell out checks * Fixed pep8 * Updated regex to only match subprocess.Popen * Added failing modules to ignore.txt * Wrong postgresql module in ignore.txt * Removed bigip from ignore.txt	7 years ago
Abhijeet Kasurde	27b85e732d	Argument spec must be dict/hash (#40858) ... validate-modules should fail when argument is not dict/hash. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>	7 years ago
Matt Clay	70c475da6c	Implement new changelog generator.	7 years ago
Sam Doran	8746d9ef87	Add guidelines on developing lookup plugins (#38681)	7 years ago
Matt Clay	8d39515914	Remove tab check from validate-modules. ... It is redundant with the pycodestyle W191 "indentation contains tabs" check.	7 years ago
Simon	fb6ae90f60	Memset: initial module, integration tests, module_utils and supporting documentation. (#40071) ... * * Memset: * module_utils and associated documentation. * module to manage DNS zones. * integration tests to run against Memset's API. * * memset.py: * remove import of requests from memset.py in favour of internal Ansible modules. * import necessary Ansible modules for request and response handling. * create a response object in order to retain a stable interface to memset_api_call from existing modules. * rework memset_api_call to remove requests. * memset_zone.py: * improve short description to be more verbose. * ensure all imports directly follow documentation. * remove any reference to requests. * correct keyerror carried over from elsewhere. * remove dependency on requests from documentation string * disable integration tests until we have a cleanup method available	7 years ago
Jon Dufresne	1d640182c6	Update all pypi.python.org URLs to pypi.org (#38988) ... For details on the new PyPI, see the blog post: https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html	7 years ago
Ken Celenza	e476089bb9	spacing issue (#39884)	7 years ago
Matt Martz	1663b64e18	Allow subspec defaults to be processed when the parent argument is not supplied (#38967) ... * Allow subspec defaults to be processed when the parent argument is not supplied * Allow this to be configurable via apply_defaults on the parent * Document attributes of arguments in argument_spec * Switch manageiq_connection to use apply_defaults * add choices to api_version in argument_spec	7 years ago
Kevin Breit	c8d287fece	Meraki organization module (#38773) ... * Initial commit Query an organization within Meraki. No support is in place for managing or creating yet * Change output_level method and make the state parameter required. * Implemented listing all organizations - Updated documentation - Parse results and return all organizations - Parse results and return specified organization * Framework for creating an organization - Documentation example for organization creation - Framework exists for creating organizations, pending PR 36809 - Created functions for HTTP calls - Renamed from dashboard.meraki.com to api.meraki.com - Added required_if for state * Remove absent state - Meraki API does not support deleting an organization so absent is removed - Updated documentation to call it state instead of status * Small change to documentation * Support all parameters associated to organization - Added all parameters needed for all organization actions. - None of the added ones work at this time. - Added documentation for clone. * Integration test for meraki_organization module * Rename module to meraki for porting to module utility * Meraki documentation fragment - Created initial documentation fragment for Meraki modules * Add meraki module utility to branch. Formerly was on a separate branch. * CRU support for Meraki organization module * CRU is supported for Meraki organizations * There is no DELETE function for organizations in the API * This code is very messy and needs cleanup * Create and Update actions don't show status as updated, must fix * Added Meraki module utility to module utility documentation list * Added support for organization cloning * Renamed use_ssl to use_https * Removed define_method() * Removed is_org() * Added is_org_valid() which does all org sanity checks * Fixes for ansibot - Changed default of use_proxy from true to false - Removed some commented out code - Updated documentation * Changes for ansibot - Removed requirement for state parameter. I may readd this. - Updated formatting diff --git a/lib/ansible/module_utils/network/meraki/meraki.py b/lib/ansible/module_utils/network/meraki/meraki.py index 3acd3d1038..395ac7c4b4 100644 --- a/lib/ansible/module_utils/network/meraki/meraki.py +++ b/lib/ansible/module_utils/network/meraki/meraki.py @@ -42,7 +42,7 @@ def meraki_argument_spec(): return dict(auth_key=dict(type='str', no_log=True, fallback=(env_fallback, ['MERAKI_KEY'])), host=dict(type='str', default='api.meraki.com'), name=dict(type='str'), - state=dict(type='str', choices=['present', 'absent', 'query'], required=True), + state=dict(type='str', choices=['present', 'absent', 'query']), use_proxy=dict(type='bool', default=False), use_https=dict(type='bool', default=True), validate_certs=dict(type='bool', default=True), diff --git a/lib/ansible/modules/network/meraki/meraki_organization.py b/lib/ansible/modules/network/meraki/meraki_organization.py index 923d969366..3789be91d6 100644 --- a/lib/ansible/modules/network/meraki/meraki_organization.py +++ b/lib/ansible/modules/network/meraki/meraki_organization.py @@ -20,11 +20,9 @@ short_description: Manage organizations in the Meraki cloud version_added: "2.6" description: - Allows for creation, management, and visibility into organizations within Meraki - notes: - More information about the Meraki API can be found at U(https://dashboard.meraki.com/api_docs). - Some of the options are likely only used for developers within Meraki - options: name: description: @@ -32,21 +30,18 @@ options: - If C(clone) is specified, C(name) is the name of the new organization. state: description: - - Create or query organizations - choices: ['query', 'present'] + - Create or modify an organization + choices: ['present', 'query'] clone: description: - Organization to clone to a new organization. - type: string org_name: description: - Name of organization. - Used when C(name) should refer to another object. - type: string org_id: description: - ID of organization - author: - Kevin Breit (@kbreit) extends_documentation_fragment: meraki @@ -86,7 +81,6 @@ RETURN = ''' response: description: Data returned from Meraki dashboard. type: dict - state: query returned: info ''' @@ -103,6 +97,7 @@ def main(): argument_spec = meraki_argument_spec() argument_spec.update(clone=dict(type='str'), + state=dict(type='str', choices=['present', 'query']), ) @@ -125,11 +120,9 @@ def main(): meraki.function = 'organizations' meraki.params['follow_redirects'] = 'all' - meraki.required_if=[ - ['state', 'present', ['name']], - ['clone', ['name']], - # ['vpn_PublicIP', ['name']], - ] + meraki.required_if = [['state', 'present', ['name']], + ['clone', ['name']], + ] create_urls = {'organizations': '/organizations', } @@ -162,23 +155,16 @@ def main(): - - # method = None - # org_id = None - - - # meraki.fail_json(msg=meraki.is_org_valid(meraki.get_orgs(), org_name='AnsibleTestOrg')) - if meraki.params['state'] == 'query': - if meraki.params['name'] is None: # Query all organizations, no matter what - orgs = meraki.get_orgs() - meraki.result['organization'] = orgs - elif meraki.params['name'] is not None: # Query by organization name - module.warn('All matching organizations will be returned, even if there are duplicate named organizations') - orgs = meraki.get_orgs() - for o in orgs: - if o['name'] == meraki.params['name']: - meraki.result['organization'] = o + if meraki.params['name'] is None: # Query all organizations, no matter what + orgs = meraki.get_orgs() + meraki.result['organization'] = orgs + elif meraki.params['name'] is not None: # Query by organization name + module.warn('All matching organizations will be returned, even if there are duplicate named organizations') + orgs = meraki.get_orgs() + for o in orgs: + if o['name'] == meraki.params['name']: + meraki.result['organization'] = o elif meraki.params['state'] == 'present': if meraki.params['clone'] is not None: # Cloning payload = {'name': meraki.params['name']} @@ -193,7 +179,10 @@ def main(): payload = {'name': meraki.params['name'], 'id': meraki.params['org_id'], } - meraki.result['response'] = json.loads(meraki.request(meraki.construct_path('update', org_id=meraki.params['org_id']), payload=json.dumps(payload), method='PUT')) + meraki.result['response'] = json.loads(meraki.request(meraki.construct_path('update', + org_id=meraki.params['org_id']), + payload=json.dumps(payload), + method='PUT')) diff --git a/lib/ansible/utils/module_docs_fragments/meraki.py b/lib/ansible/utils/module_docs_fragments/meraki.py index e268d02e68..3569d83b99 100644 --- a/lib/ansible/utils/module_docs_fragments/meraki.py +++ b/lib/ansible/utils/module_docs_fragments/meraki.py @@ -35,6 +35,7 @@ options: description: - Set amount of debug output during module execution choices: ['normal', 'debug'] + default: 'normal' timeout: description: - Time to timeout for HTTP requests. diff --git a/test/integration/targets/meraki_organization/aliases b/test/integration/targets/meraki_organization/aliases new file mode 100644 index 0000000000..ad7ccf7ada --- /dev/null +++ b/test/integration/targets/meraki_organization/aliases @@ -0,0 +1 @@ +unsupported * Formatting fix * Minor updates due to testing - Made state required again - Improved formatting for happier PEP8 - request() now sets instance method * Fix reporting of the result * Enhance idempotency checks - Remove merging functionality as the proposed should be used - Do check and reverse check to look for differences * Rewrote and added additional integration tests. This isn't done. * Updated is_update_required method: - Original and proposed data is passed to method - Added ignored_keys list so it can be skipped if needed * Changes per comments from dag - Optionally assign function on class instantiation - URLs now have {} for substitution method - Move auth_key check to module utility - Remove is_new and get_existing - Minor changes to documentation * Enhancements for future modules and organization - Rewrote construct_path method for simplicity - Increased support for network functionality to be committed * Changes based on Dag feedback and to debug problems * Minor fixes for validitation testing * Small changes for dag and Ansibot - Changed how auth_key is processed - Removed some commented lines - Updated documentation fragment, but that may get reverted * Remove blank line and comment * Improvements for testing and code simplification - Added network integration tests - Modified error handling in request() - More testing to come on this - Rewrote construct_path again. Very simple now. * Remove trailing whitespace * Small changes based on dag's response * Removed certain sections from exit_json and fail_json as they're old	7 years ago
Alicia Cozine	c8a9b411bc	Last docs link fixes (#39391) ... * should not need <>, but fails without * adds anchor to keywords page, uses it on plugins pages * fixes envvar link errors * harmonize file name and ref name as python_3 * removes undefined-lable from ignore list	7 years ago
Abhijeet Kasurde	9f1254a32f	Typo fix in testing link (#39407) ... Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>	7 years ago
Alicia Cozine	4b52a54e18	Reduce warnings (#39254) ... * removes FAQ links; no entries exist for linked config settings * fixes various anchors and links * addresses abadger comments, thanks * marks orphan pages, avoids TOC errors * adds links for remote_tmp setting to FAQ	7 years ago
Matt Clay	7975c8fab0	Improve integration-aliases docs. (#39087)	7 years ago
Alicia Cozine	8f83061e70	corrects links to 'list_of' pages (#39161)	7 years ago
Matt Clay	c262dbfd30	Use https for links to ansible.com domains.	7 years ago
Alicia Cozine	bbfd6c6ab1	Internal refs (#39094) ... * fixes community refs * fixes appendix refs * fixes scenario refs, keeps ACI guide link to devel * fixes windows refs * fixes user guide refs * fixes dev guide refs	7 years ago
Alicia Cozine	64dcc7def0	Fixes more rST errors (#39042) ... * removes include, avoids duplicate label rST warnings * reduces literal_block errors on playbooks_filters * addresses TOC errors * ref error on modules page * trying ref for list_of_database_modules	7 years ago
Toshio Kuratomi	9faf7b949e	Fix places in docs that refer to modules without namespace ... We've namespaced all plugin docs. Change the docs to reflect that	7 years ago