Class: Ansible::Ruby::Modules::Gitlab_user

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb

Overview

When the user does not exists in Gitlab, it will be created. When the user does exists and state=absent, the user will be deleted. When changes are made to user, the user will be updated.

Instance Method Summary

• #access_level ⇒ Object^?

  The access level to the group.

• #email ⇒ String

  The email that belongs to the user.

• #group ⇒ Object^?

  Add user as an member to this group.

• #login_password ⇒ String^?

  Gitlab password for login_user.

• #login_token ⇒ String^?

  Gitlab token for logging in.

• #login_user ⇒ String^?

  Gitlab user name.

• #name ⇒ String

  Name of the user you want to create.

• #password ⇒ String

  The password of the user.

• #server_url ⇒ String

  Url of Gitlab server, with protocol (http or https).

• #sshkey_file ⇒ String^?

  The ssh key itself.

• #sshkey_name ⇒ String^?

  The name of the sshkey.

• #state ⇒ :present, ...

  Create or delete group.,Possible values are present and absent.

• #username ⇒ String

  The username of the user.

• #validate_certs ⇒ Boolean^?

  When using https if SSL certificate needs to be verified.

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

#access_level ⇒ Object^?

Returns The access level to the group. One of the following can be used.,guest,reporter,developer,master,owner.

Returns:

• (Object, nil) —

  The access level to the group. One of the following can be used.,guest,reporter,developer,master,owner

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 60

attribute :access_level

#email ⇒ String

Returns The email that belongs to the user.

Returns:

• (String) —

  The email that belongs to the user.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 45

attribute :email

#group ⇒ Object^?

Returns Add user as an member to this group.

Returns:

• (Object, nil) —

  Add user as an member to this group.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 57

attribute :group

#login_password ⇒ String^?

Returns Gitlab password for login_user.

Returns:

• (String, nil) —

  Gitlab password for login_user

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 25

attribute :login_password

#login_token ⇒ String^?

Returns Gitlab token for logging in.

Returns:

• (String, nil) —

  Gitlab token for logging in.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 29

attribute :login_token

#login_user ⇒ String^?

Returns Gitlab user name.

Returns:

• (String, nil) —

  Gitlab user name.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 21

attribute :login_user

#name ⇒ String

Returns Name of the user you want to create.

Returns:

• (String) —

  Name of the user you want to create

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 33

attribute :name

#password ⇒ String

Returns The password of the user.

Returns:

• (String) —

  The password of the user.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 41

attribute :password

#server_url ⇒ String

Returns Url of Gitlab server, with protocol (http or https).

Returns:

• (String) —

  Url of Gitlab server, with protocol (http or https).

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 13

attribute :server_url

#sshkey_file ⇒ String^?

Returns The ssh key itself.

Returns:

• (String, nil) —

  The ssh key itself.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 53

attribute :sshkey_file

#sshkey_name ⇒ String^?

Returns The name of the sshkey.

Returns:

• (String, nil) —

  The name of the sshkey

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 49

attribute :sshkey_name

#state ⇒ :present, ...

Returns create or delete group.,Possible values are present and absent.

Returns:

• (:present, :absent, nil) —

  create or delete group.,Possible values are present and absent.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 63

attribute :state

#username ⇒ String

Returns The username of the user.

Returns:

• (String) —

  The username of the user.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 37

attribute :username

#validate_certs ⇒ Boolean^?

Returns When using https if SSL certificate needs to be verified.

Returns:

• (Boolean, nil) —

  When using https if SSL certificate needs to be verified.

# File 'lib/ansible/ruby/modules/generated/extras/source_control/gitlab_user.rb', line 17

attribute :validate_certs