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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/database/vertica/vertica_role.rb

Overview

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

Instance Method Summary

• #assigned_roles ⇒ Object^?

  Comma separated list of roles to assign to the role.

• #cluster ⇒ String^?

  Name of the Vertica cluster.

• #db ⇒ String^?

  Name of the Vertica database.

• #login_password ⇒ Object^?

  The password used to authenticate with.

• #login_user ⇒ String^?

  The username used to authenticate with.

• #name ⇒ String

  Name of the role to add or remove.

• #port ⇒ Integer^?

  Vertica cluster port to connect to.

• #state ⇒ :present, ...

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

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.

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

attribute :assigned_roles

#cluster ⇒ String^?

Returns Name of the Vertica cluster.

Returns:

• (String, nil) —

  Name of the Vertica cluster.

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

attribute :cluster

#db ⇒ String^?

Returns Name of the Vertica database.

Returns:

• (String, nil) —

  Name of the Vertica database.

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

attribute :db

#login_password ⇒ Object^?

Returns The password used to authenticate with.

Returns:

• (Object, nil) —

  The password used to authenticate with.

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

attribute :login_password

#login_user ⇒ String^?

Returns The username used to authenticate with.

Returns:

• (String, nil) —

  The username used to authenticate with.

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

attribute :login_user

#name ⇒ String

Returns Name of the role to add or remove.

Returns:

• (String) —

  Name of the role to add or remove.

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

attribute :name

#port ⇒ Integer^?

Returns Vertica cluster port to connect to.

Returns:

• (Integer, nil) —

  Vertica cluster port to connect to.

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

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.

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

attribute :state