cisco.meraki.meraki_config_template (2.18.0) — module

Install collection

Install with ansible-galaxy collection install cisco.meraki:==2.18.0

Add to requirements.yml

  collections:
    - name: cisco.meraki
      version: 2.18.0

Description

Allows for querying, deleting, binding, and unbinding of configuration templates.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query configuration templates
  meraki_config_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Bind a template from a network
  meraki_config_template:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    config_template: DevConfigTemplate
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Unbind a template from a network
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    config_template: DevConfigTemplate
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete a configuration template
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    config_template: DevConfigTemplate
  delegate_to: localhost

Inputs

    
host:
    default: api.meraki.com
    description:
    - Hostname for Meraki dashboard.
    - Can be used to access regional Meraki environments, such as China.
    type: str

state:
    choices:
    - absent
    - query
    - present
    default: query
    description:
    - Specifies whether configuration template information should be queried, modified,
      or deleted.
    type: str

net_id:
    description:
    - ID of the network to bind or unbind configuration template to.
    type: str

org_id:
    description:
    - ID of organization associated to a configuration template.
    type: str

timeout:
    default: 30
    description:
    - Time to timeout for HTTP requests.
    type: int

auth_key:
    description:
    - Authentication key provided by the dashboard. Required if environmental variable
      C(MERAKI_KEY) is not set.
    required: true
    type: str

net_name:
    description:
    - Name of the network to bind or unbind configuration template to.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization containing the configuration template.
    type: str

auto_bind:
    description:
    - Optional boolean indicating whether the network's switches should automatically
      bind to profiles of the same model.
    - This option only affects switch networks and switch templates.
    - Auto-bind is not valid unless the switch template has at least one profile and has
      at most one profile per switch model.
    type: bool

use_https:
    default: true
    description:
    - If C(no), it will use HTTP. Otherwise it will use HTTPS.
    - Only useful for internal Meraki developers.
    type: bool

use_proxy:
    default: false
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

output_level:
    choices:
    - debug
    - normal
    default: normal
    description:
    - Set amount of debug output during module execution.
    type: str

output_format:
    choices:
    - snakecase
    - camelcase
    default: snakecase
    description:
    - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel
      case (ex. C(netId)).
    type: str

validate_certs:
    default: true
    description:
    - Whether to validate HTTP certificates.
    type: bool

config_template:
    aliases:
    - name
    description:
    - Name of the configuration template within an organization to manipulate.
    type: str

rate_limit_retry_time:
    default: 165
    description:
    - Number of seconds to retry if rate limiter is triggered.
    type: int

internal_error_retry_time:
    default: 60
    description:
    - Number of seconds to retry if server returns an internal server error.
    type: int

Outputs

data:
  contains:
    id:
      description: Unique identification number of organization.
      returned: success
      sample: L_2930418
      type: int
    name:
      description: Name of configuration template.
      returned: success
      sample: YourTemplate
      type: str
    product_types:
      description: List of products which can exist in the network.
      returned: success
      sample:
      - appliance
      - switch
      type: list
    time_zone:
      description: Timezone applied to each associated network.
      returned: success
      sample: America/Chicago
      type: str
  description: Information about queried object.
  returned: success
  type: complex