Class: Ansible::Ruby::Modules::Meraki_admin

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb

Overview

Allows for creation, management, and visibility into administrators within Meraki.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#email ⇒ String?

Returns Email address for the dashboard administrator.,Email cannot be updated.,Required when creating or editing an administrator.

Returns:

  • (String, nil) —

    Email address for the dashboard administrator.,Email cannot be updated.,Required when creating or editing an administrator.



16
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 16

attribute :email

#name ⇒ String?

Returns Name of the dashboard administrator.,Required when creating a new administrator.

Returns:

  • (String, nil) —

    Name of the dashboard administrator.,Required when creating a new administrator.



12
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 12

attribute :name

#networks ⇒ Object?

Returns List of networks the administrator has privileges on.,When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.

Returns:

  • (Object, nil) —

    List of networks the administrator has privileges on.,When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.



27
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 27

attribute :networks

#org_id ⇒ Integer?

Returns ID of organization.

Returns:

  • (Integer, nil) —

    ID of organization.



38
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 38

attribute :org_id

#org_name ⇒ String?

Returns Name of organization.,Used when C(name) should refer to another object.,When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.

Returns:

  • (String, nil) —

    Name of organization.,Used when C(name) should refer to another object.,When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.



34
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 34

attribute :org_name

#orgAccess ⇒ :full, ...

Returns Privileges assigned to the administrator in the organization.

Returns:

  • (:full, :none, :"read-only", nil) —

    Privileges assigned to the administrator in the organization.



20
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 20

attribute :orgAccess

#state ⇒ :absent, ...

Returns Create or modify an organization.

Returns:

  • (:absent, :present, :query) —

    Create or modify an organization



30
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 30

attribute :state

#tags ⇒ Object?

Returns Tags the administrator has privileges on.,When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.,If C(none) is specified, C(network) or C(tags) must be specified.

Returns:

  • (Object, nil) —

    Tags the administrator has privileges on.,When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.,If C(none) is specified, C(network) or C(tags) must be specified.



24
 
# File 'lib/ansible/ruby/modules/generated/network/meraki/meraki_admin.rb', line 24

attribute :tags