Class: Ansible::Ruby::Modules::Ipa_user

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ipa_user

Defined in:

lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb

Overview

Add, modify and delete user within IPA server

Instance Method Summary

• #displayname ⇒ Object^?

  Display name.

• #gidnumber ⇒ Integer^?

  Posix Group ID.

• #givenname ⇒ String^?

  First name.

• #krbpasswordexpiration ⇒ Integer^?

  Date at which the user password will expire,In the format YYYYMMddHHmmss,e.g.

• #loginshell ⇒ Object^?

  Login shell.

• #mail ⇒ Array<String>, ...

  List of mail addresses assigned to the user.,If an empty list is passed all assigned email addresses will be deleted.,If None is passed email addresses will not be checked or changed.

• #password ⇒ Object^?

  Password for new user.

• #sn ⇒ String^?

  Surname.

• #sshpubkey ⇒ Array<String>, ...

  List of public SSH key.,If an empty list is passed all assigned public keys will be deleted.,If None is passed SSH public keys will not be checked or changed.

• #state ⇒ :present, ...

  State to ensure.

• #telephonenumber ⇒ Array<Integer>, ...

  List of telephone numbers assigned to the user.,If an empty list is passed all assigned telephone numbers will be deleted.,If None is passed telephone numbers will not be checked or changed.

• #title ⇒ Object^?

  Title.

• #uid ⇒ Object

  Uid of the user.

• #uidnumber ⇒ Integer^?

  Account Settings UID/Posix User ID number.

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

#displayname ⇒ Object^?

Returns Display name.

Returns:

• (Object, nil) —

  Display name

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

attribute :displayname

#gidnumber ⇒ Integer^?

Returns Posix Group ID.

Returns:

• (Integer, nil) —

  Posix Group ID

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 60

attribute :gidnumber

#givenname ⇒ String^?

Returns First name.

Returns:

• (String, nil) —

  First name

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 15

attribute :givenname

#krbpasswordexpiration ⇒ Integer^?

Returns Date at which the user password will expire,In the format YYYYMMddHHmmss,e.g. 20180121182022 will expire on 21 January 2018 at 18:20:22.

Returns:

• (Integer, nil) —

  Date at which the user password will expire,In the format YYYYMMddHHmmss,e.g. 20180121182022 will expire on 21 January 2018 at 18:20:22

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 19

attribute :krbpasswordexpiration

#loginshell ⇒ Object^?

Returns Login shell.

Returns:

• (Object, nil) —

  Login shell

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 23

attribute :loginshell

#mail ⇒ Array<String>, ...

Returns List of mail addresses assigned to the user.,If an empty list is passed all assigned email addresses will be deleted.,If None is passed email addresses will not be checked or changed.

Returns:

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

  List of mail addresses assigned to the user.,If an empty list is passed all assigned email addresses will be deleted.,If None is passed email addresses will not be checked or changed.

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 26

attribute :mail

#password ⇒ Object^?

Returns Password for new user.

Returns:

• (Object, nil) —

  Password for new user

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 30

attribute :password

#sn ⇒ String^?

Returns Surname.

Returns:

• (String, nil) —

  Surname

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 33

attribute :sn

#sshpubkey ⇒ Array<String>, ...

Returns List of public SSH key.,If an empty list is passed all assigned public keys will be deleted.,If None is passed SSH public keys will not be checked or changed.

Returns:

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

  List of public SSH key.,If an empty list is passed all assigned public keys will be deleted.,If None is passed SSH public keys will not be checked or changed.

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 37

attribute :sshpubkey

#state ⇒ :present, ...

Returns State to ensure.

Returns:

• (:present, :absent, :enabled, :disabled, nil) —

  State to ensure

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 41

attribute :state

#telephonenumber ⇒ Array<Integer>, ...

Returns List of telephone numbers assigned to the user.,If an empty list is passed all assigned telephone numbers will be deleted.,If None is passed telephone numbers will not be checked or changed.

Returns:

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

  List of telephone numbers assigned to the user.,If an empty list is passed all assigned telephone numbers will be deleted.,If None is passed telephone numbers will not be checked or changed.

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 45

attribute :telephonenumber

#title ⇒ Object^?

Returns Title.

Returns:

• (Object, nil) —

  Title

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 49

attribute :title

#uid ⇒ Object

Returns uid of the user.

Returns:

• (Object) —

  uid of the user

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 52

attribute :uid

#uidnumber ⇒ Integer^?

Returns Account Settings UID/Posix User ID number.

Returns:

• (Integer, nil) —

  Account Settings UID/Posix User ID number

# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_user.rb', line 56

attribute :uidnumber