Deprecated

Removed in 3.0.0

i

Reason:Updated modules released with increased functionality | Alternative:cisco.meraki.networks_switch_access_policies

cisco.meraki.meraki_ms_access_policies (2.18.0) — module

Manage Switch Access Policies in the Meraki cloud

Authors: Marcin Woźniak (@y0rune)

deprecated | supported by community

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

Module for managing a Switch Access Policies in the Meraki cloud

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create access policy with auth_method is "Meraki authentication"
  cisco.meraki.meraki_ms_access_policies:
    auth_key: abc123
    state: present
    name: "Meraki authentication policy"
    auth_method: "Meraki authentication"
    net_name: YourNet
    org_name: YourOrg
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create access policy with auth_method is "my Radius Server"
  cisco.meraki.meraki_ms_access_policies:
    auth_key: abc123
    access_policy_type: "802.1x"
    host_mode: "Single-Host"
    state: present
    name: "Meraki authentication policy"
    auth_method: "my RADIUS server"
    radius_servers:
      - host: 192.0.1.18
        port: 7890
        secret: secret123
    net_name: YourNet
    org_name: YourOrg
    radius_coa_enabled: False
    radius_accounting_enabled: False
    guest_vlan: 10
    voice_vlan_clients: False

Inputs

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

name:
    description:
    - Name of Access Policy.
    type: str

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

net_id:
    description:
    - ID of network.
    type: str

number:
    aliases:
    - access_policy_number
    description:
    - Number of the access_policy.
    type: int

org_id:
    description:
    - ID of organization associated to a network.
    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:
    aliases:
    - name
    - network
    description:
    - Name of a network.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    type: str

host_mode:
    choices:
    - Single-Host
    - Multi-Domain
    - Multi-Host
    - Multi-Auth
    description:
    - Choose the Host Mode for the access policy.
    type: str

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

guest_vlan:
    description:
    - Guest Vlan
    type: int

auth_method:
    choices:
    - Meraki authentication
    - my RADIUS server
    description:
    - Set authentication method in the policy.
    type: str

data_vlan_id:
    description:
    - Set a Data VLAN ID for Critical Auth VLAN
    type: int

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

voice_vlan_id:
    description:
    - Set a Voice VLAN ID for Critical Auth VLAN
    type: int

radius_servers:
    description:
    - List of RADIUS servers.
    elements: dict
    suboptions:
      host:
        description:
        - IP address or hostname of RADIUS server.
        required: true
        type: str
      port:
        description:
        - Port number RADIUS server is listening to.
        type: int
      secret:
        description:
        - RADIUS password.
        - Setting password is not idempotent.
        type: str
    type: list

radius_testing:
    default: true
    description:
    - Set status of testing a radius.
    type: bool

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

access_policy_type:
    choices:
    - 802.1x
    - MAC authentication bypass
    - Hybrid authentication
    description:
    - Set type of the access policy
    type: str

radius_coa_enabled:
    description:
    - Enable or disable RADIUS CoA (Change of Authorization).
    type: bool

voice_vlan_clients:
    default: true
    description:
    - If is enabled that means Voice VLAN client require authentication
    type: bool

suspend_port_bounce:
    default: false
    description:
    - Enable or disable the Suspend Port Bounce when RADIUS servers are unreachable.
    type: bool

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

radius_accounting_enabled:
    description:
    - Enable or disable RADIUS accounting.
    type: bool

radius_accounting_servers:
    description:
    - List of RADIUS servers for RADIUS accounting.
    elements: dict
    suboptions:
      host:
        description:
        - IP address or hostname of RADIUS server.
        required: true
        type: str
      port:
        description:
        - Port number RADIUS server is listening to.
        type: int
      secret:
        description:
        - RADIUS password.
        type: str
    type: list

systems_management_enrollment:
    default: false
    description:
    - Set if the Systems Management Enrollemnt is enabled or disabled
    type: bool

radius_attribute_group_policy_name:
    choices:
    - Filter-Id
    - ''
    default: ''
    description:
    - Enable that attribute for a RADIUS
    type: str

Outputs

data:
  contains:
    access_policy_type:
      description: Type of the access policy
      returned: success
      sample: 802.1x
      type: str
    guest_vlan_id:
      description: ID of the Guest Vlan
      returned: success
      sample: 10
      type: int
    host_mode:
      description: Choosen teh Host Mode for the access policy
      returned: success
      sample: Single-Host
      type: str
    name:
      description: Name of the Access Policy
      returned: success
      sample: Policy with 802.1x
      type: str
    number:
      description: Number of the Access Policy
      returned: success
      sample: 1
      type: int
    radius:
      contains:
        critial_auth:
          contains:
            data_vlan_id:
              description: VLAN ID for data
              returned: success
              sample: 10
              type: int
            suspend_port_bounce:
              description: Enable or disable suspend port bounce
              returned: success
              sample: false
              type: bool
            voice_vlan_id:
              description: VLAN ID for voice
              returned: success
              sample: 10
              type: int
          description: Critial Auth List
          returned: success
          type: complex
        failed_auth_vlan_id:
          description: VLAN ID when failed auth
          returned: success
          sample: 11
          type: int
        re_authentication_interval:
          description: Interval of re-authentication
          returned: success
          sample: null
          type: int
      description: List of radius specific list
      returned: success
      type: complex
    radius_accounting_enabled:
      description:
      - Enable or disable RADIUS accounting.
      type: bool
    radius_accounting_servers:
      description:
      - List of RADIUS servers for RADIUS accounting.
      elements: dict
      type: list
    radius_attribute_group_policy_name:
      choices:
      - '11'
      - ''
      description: Enable the radius group attribute
      returned: success
      sample: 11
      type: str
    radius_coa_enabled:
      description:
      - Enable or disable RADIUS CoA (Change of Authorization).
      type: bool
    radius_servers:
      description:
      - List of RADIUS servers.
      elements: dict
      type: list
    radius_testing_enabled:
      description: Enable or disable Radius Testing
      returned: success
      sample: true
      type: bool
    voice_vlan_clients:
      description: Enable or disable Voice Vlan Clients
      returned: success
      sample: false
      type: bool
  description: List of Access Policies
  returned: success
  type: complex