Class: Ansible::Ruby::Modules::Vertica_role

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb

Overview

Adds or removes Vertica database role and, optionally, assign other roles.

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

#assigned_roles ⇒ Object?

Returns Comma separated list of roles to assign to the role.

Returns:

  • (Object, nil) —

    Comma separated list of roles to assign to the role.



16
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 16

attribute :assigned_roles

#cluster ⇒ String?

Returns Name of the Vertica cluster.

Returns:

  • (String, nil) —

    Name of the Vertica cluster.



27
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 27

attribute :cluster

#db ⇒ String?

Returns Name of the Vertica database.

Returns:

  • (String, nil) —

    Name of the Vertica database.



23
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 23

attribute :db

#login_password ⇒ Object?

Returns The password used to authenticate with.

Returns:

  • (Object, nil) —

    The password used to authenticate with.



39
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 39

attribute :login_password

#login_user ⇒ String?

Returns The username used to authenticate with.

Returns:

  • (String, nil) —

    The username used to authenticate with.



35
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 35

attribute :login_user

#name ⇒ String

Returns Name of the role to add or remove.

Returns:

  • (String) —

    Name of the role to add or remove.



12
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 12

attribute :name

#port ⇒ Integer?

Returns Vertica cluster port to connect to.

Returns:

  • (Integer, nil) —

    Vertica cluster port to connect to.



31
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 31

attribute :port

#state ⇒ :present, ...

Returns Whether to create C(present), drop C(absent) or lock C(locked) a role.

Returns:

  • (:present, :absent, nil) —

    Whether to create C(present), drop C(absent) or lock C(locked) a role.



19
 
# File 'lib/ansible/ruby/modules/generated/database/vertica/vertica_role.rb', line 19

attribute :state