.command_guide_template.md

< (Back) to Meraki-CLI Home

Meraki-CLI Command Guide

Below is a list of commands supported by the Meraki-CLI tool.

This documentation is built automatically by parsing the Meraki Dashboard API Python SDK and may not be 100% up to date since that library changes regularly.

Version

This command guide is based on version v{{ version }} of the Meraki Dashboard API Python SDK. If you want to see the version of the SDK you have installed, issue the command meraki -v.

TABLE OF CONTENTS

{% for name, object in struct.items() recursive %}{{ " " * (loop.depth - 1) }}- [{{ _cmd_title(name) }}](#{{ _uri_name(name) }}) {% if object is mapping %}{{ loop(object.items()) }}{% endif %}{% endfor %}

{% for name, object in struct.items() recursive %} {% if object is mapping %}# {{ _cmd_title(name) }}{{ loop(object.items()) }}{% else %}

---

{{ _cmd_title(name) }}

{{ _cmd_section(object) }} {% if object.varkw %}

Example:

meraki {{ object.path }}{{ _cmd_args(object) }} --optionalArg1 "optionalarg1value" --optionalArg2 "optionalarg2value"

Example using --kwargs (Advanced):

meraki {{ object.path }}{{ _cmd_args(object) }} --{{object.varkw.name}} '{"key1": "value1", "key2": "value2"}'

{% else %}

Example:

meraki {{ object.path }}{{ _cmd_args(object) }}

{% endif %}

Method Code:

def {{ object.name }}{{ object.signature }}:
    # Code

{% endif %}{% endfor %}