Class: Ansible::Ruby::Modules::Ipa_role

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb

Overview

Add, modify and delete a role within FreeIPA server using FreeIPA API

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#cn ⇒ Object

Returns Role name.,Can not be changed as it is the unique identifier.

Returns:

  • (Object) —

    Role name.,Can not be changed as it is the unique identifier.



12
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 12

attribute :cn

#description ⇒ String?

Returns A description of this role-group.

Returns:

  • (String, nil) —

    A description of this role-group.



16
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 16

attribute :description

#group ⇒ Array<String>, ...

Returns List of group names assign to this role.,If an empty list is passed all assigned groups will be unassigned from the role.,If option is omitted groups will not be checked or changed.,If option is passed all assigned groups that are not passed will be unassigned from the role.

Returns:

  • (Array<String>, String, nil) —

    List of group names assign to this role.,If an empty list is passed all assigned groups will be unassigned from the role.,If option is omitted groups will not be checked or changed.,If option is passed all assigned groups that are not passed will be unassigned from the role.



20
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 20

attribute :group

#host ⇒ Array<String>, ...

Returns List of host names to assign.,If an empty list is passed all assigned hosts will be unassigned from the role.,If option is omitted hosts will not be checked or changed.,If option is passed all assigned hosts that are not passed will be unassigned from the role.

Returns:

  • (Array<String>, String, nil) —

    List of host names to assign.,If an empty list is passed all assigned hosts will be unassigned from the role.,If option is omitted hosts will not be checked or changed.,If option is passed all assigned hosts that are not passed will be unassigned from the role.



24
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 24

attribute :host

#hostgroup ⇒ Array<String>, ...

Returns List of host group names to assign.,If an empty list is passed all assigned host groups will be removed from the role.,If option is omitted host groups will not be checked or changed.,If option is passed all assigned hostgroups that are not passed will be unassigned from the role.

Returns:

  • (Array<String>, String, nil) —

    List of host group names to assign.,If an empty list is passed all assigned host groups will be removed from the role.,If option is omitted host groups will not be checked or changed.,If option is passed all assigned hostgroups that are not passed will be unassigned from the role.



28
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 28

attribute :hostgroup

#privilege ⇒ Array<String>, ...

Returns List of privileges granted to the role.,If an empty list is passed all assigned privileges will be removed.,If option is omitted privileges will not be checked or changed.,If option is passed all assigned privileges that are not passed will be removed.

Returns:

  • (Array<String>, String, nil) —

    List of privileges granted to the role.,If an empty list is passed all assigned privileges will be removed.,If option is omitted privileges will not be checked or changed.,If option is passed all assigned privileges that are not passed will be removed.



32
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 32

attribute :privilege

#service ⇒ Array<String>, ...

Returns List of service names to assign.,If an empty list is passed all assigned services will be removed from the role.,If option is omitted services will not be checked or changed.,If option is passed all assigned services that are not passed will be removed from the role.

Returns:

  • (Array<String>, String, nil) —

    List of service names to assign.,If an empty list is passed all assigned services will be removed from the role.,If option is omitted services will not be checked or changed.,If option is passed all assigned services that are not passed will be removed from the role.



36
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 36

attribute :service

#state ⇒ :present, ...

Returns State to ensure.

Returns:

  • (:present, :absent, nil) —

    State to ensure



40
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 40

attribute :state

#user ⇒ Array<String>, ...

Returns List of user names to assign.,If an empty list is passed all assigned users will be removed from the role.,If option is omitted users will not be checked or changed.

Returns:

  • (Array<String>, String, nil) —

    List of user names to assign.,If an empty list is passed all assigned users will be removed from the role.,If option is omitted users will not be checked or changed.



44
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_role.rb', line 44

attribute :user