Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

meraki_admin - Added full return documentation for normal responses #42487

Merged
merged 2 commits into from
Jul 9, 2018

Conversation

kbreit
Copy link
Contributor

@kbreit kbreit commented Jul 9, 2018

SUMMARY

Added full documentation to the module response.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

meraki_admin

ANSIBLE VERSION
ansible 2.7.0.dev0 (meraki/doc-response-admin d3746a66b9) last updated 2018/07/08 21:06:18 (GMT -500)
  config file = None
  configured module search path = ['/Users/kbreit/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/kbreit/Documents/Programming/ansible/lib/ansible
  executable location = /Users/kbreit/Documents/Programming/ansible/bin/ansible
  python version = 3.5.4 (default, Feb 25 2018, 14:56:02) [GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.39.2)]

ADDITIONAL INFORMATION

Shown by the following task in a playbook. Copied from integration test. Different combinations of orgAccess, networks, and tags for permissions will give different output.

  - name: Create new administrator
    meraki_admin:
      auth_key:abc123
      state: present
      org_name:YourOrg
      name: Jane Doe
      email: your@email.com
      tags:
        - { "tag": "production", "access": "read-only" }

      orgAccess: read-only

@ansibot
Copy link
Contributor

ansibot commented Jul 9, 2018

@ansibot ansibot added affects_2.7 This issue/PR affects Ansible v2.7 community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. meraki Cisco Meraki community module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. networking Network category owner_pr This PR is made by the module's maintainer. support:community This issue/PR relates to code supported by the Ansible community. labels Jul 9, 2018
- Old responses were saying always returned, should have been success
or something more refined
@dagwieers dagwieers merged commit 5960b21 into ansible:devel Jul 9, 2018
@kbreit kbreit deleted the meraki/doc-response-admin branch July 9, 2018 09:28
kbreit added a commit to kbreit/ansible that referenced this pull request Jul 9, 2018
…nsible#42487)

* Added full return documentation for normal responses

* Changed returned for responses

- Old responses were saying always returned, should have been success
or something more refined

(cherry picked from commit 5960b21)
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Jul 9, 2018
mattclay pushed a commit that referenced this pull request Jul 17, 2018
…42487)

* Added full return documentation for normal responses

* Changed returned for responses

- Old responses were saying always returned, should have been success
or something more refined

(cherry picked from commit 5960b21)
@dagwieers dagwieers added the cisco Cisco technologies label Feb 22, 2019
@ansible ansible locked and limited conversation to collaborators Jul 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.7 This issue/PR affects Ansible v2.7 cisco Cisco technologies community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. meraki Cisco Meraki community module This issue/PR relates to a module. networking Network category owner_pr This PR is made by the module's maintainer. support:community This issue/PR relates to code supported by the Ansible community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants