Class: Ansible::Ruby::Modules::Tower_credential

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb

Overview

Create, update, or destroy Ansible Tower credentials. See U(www.ansible.com/tower) for an overview.

Instance Method Summary

• #authorize ⇒ :yes, ...

  Should use authorize for net type.

• #authorize_password ⇒ Object^?

  Password for net credentials that require authorize.

• #become_method ⇒ :None, ...

  Become method to Use for privledge escalation.

• #become_password ⇒ Object^?

  Become password.

• #become_username ⇒ Object^?

  Become username.

• #client ⇒ Object^?

  Client or application ID for azure_rm type.

• #description ⇒ String^?

  The description to use for the credential.

• #domain ⇒ Object^?

  Domain for openstack type.

• #host ⇒ Object^?

  Host for this credential.

• #kind ⇒ :ssh, ...

  Type of credential being added.

• #name ⇒ String

  The name to use for the credential.

• #organization ⇒ String^?

  Organization that should own the credential.

• #password ⇒ Object^?

  Password for this credential.

• #project ⇒ Object^?

  Project that should for this credential.

• #secret ⇒ Object^?

  Secret token for azure_rm type.

• #security_token ⇒ Object^?

  STS token for aws type.

• #ssh_key_data ⇒ Object^?

  Path to SSH private key.

• #ssh_key_unlock ⇒ Object^?

  Unlock password for ssh_key.

• #state ⇒ :present, ...

  Desired state of the resource.

• #subscription ⇒ Object^?

  Subscription ID for azure_rm type.

• #team ⇒ Object^?

  Team that should own this credential.

• #tenant ⇒ Object^?

  Tenant ID for azure_rm type.

• #user ⇒ Object^?

  User that should own this credential.

• #username ⇒ Object^?

  Username for this credential.

• #vault_password ⇒ Object^?

  Vault password.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#authorize ⇒ :yes, ...

Returns Should use authorize for net type.

Returns:

• (:yes, :no, nil) —

  Should use authorize for net type.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 52

attribute :authorize

#authorize_password ⇒ Object^?

Returns Password for net credentials that require authorize.

Returns:

• (Object, nil) —

  Password for net credentials that require authorize.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 56

attribute :authorize_password

#become_method ⇒ :None, ...

Returns Become method to Use for privledge escalation.

Returns:

• (:None, :sudo, :su, :pbrun, :pfexec, :pmrun, nil) —

  Become method to Use for privledge escalation.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 77

attribute :become_method

#become_password ⇒ Object^?

Returns Become password. Use ASK for prompting.

Returns:

• (Object, nil) —

  Become password. Use ASK for prompting.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 84

attribute :become_password

#become_username ⇒ Object^?

Returns Become username. Use ASK for prompting.

Returns:

• (Object, nil) —

  Become username. Use ASK for prompting.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 81

attribute :become_username

#client ⇒ Object^?

Returns Client or application ID for azure_rm type.

Returns:

• (Object, nil) —

  Client or application ID for azure_rm type.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 59

attribute :client

#description ⇒ String^?

Returns The description to use for the credential.

Returns:

• (String, nil) —

  The description to use for the credential.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 16

attribute :description

#domain ⇒ Object^?

Returns Domain for openstack type.

Returns:

• (Object, nil) —

  Domain for openstack type.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 74

attribute :domain

#host ⇒ Object^?

Returns Host for this credential.

Returns:

• (Object, nil) —

  Host for this credential.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 37

attribute :host

#kind ⇒ :ssh, ...

Returns Type of credential being added.

Returns:

• (:ssh, :vault, :net, :scm, :aws, :vmware, :satellite6, :cloudforms, :gce, :azure_rm, :openstack, :rhv, :insights, :tower) —

  Type of credential being added.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 33

attribute :kind

#name ⇒ String

Returns The name to use for the credential.

Returns:

• (String) —

  The name to use for the credential.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 12

attribute :name

#organization ⇒ String^?

Returns Organization that should own the credential.

Returns:

• (String, nil) —

  Organization that should own the credential.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 29

attribute :organization

#password ⇒ Object^?

Returns Password for this credential. Use ASK for prompting. secret_key for AWS. api_key for RAX.

Returns:

• (Object, nil) —

  Password for this credential. Use ASK for prompting. secret_key for AWS. api_key for RAX.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 43

attribute :password

#project ⇒ Object^?

Returns Project that should for this credential.

Returns:

• (Object, nil) —

  Project that should for this credential.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 26

attribute :project

#secret ⇒ Object^?

Returns Secret token for azure_rm type.

Returns:

• (Object, nil) —

  Secret token for azure_rm type.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 65

attribute :secret

#security_token ⇒ Object^?

Returns STS token for aws type.

Returns:

• (Object, nil) —

  STS token for aws type.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 62

attribute :security_token

#ssh_key_data ⇒ Object^?

Returns Path to SSH private key.

Returns:

• (Object, nil) —

  Path to SSH private key.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 46

attribute :ssh_key_data

#ssh_key_unlock ⇒ Object^?

Returns Unlock password for ssh_key. Use ASK for prompting.

Returns:

• (Object, nil) —

  Unlock password for ssh_key. Use ASK for prompting.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 49

attribute :ssh_key_unlock

#state ⇒ :present, ...

Returns Desired state of the resource.

Returns:

• (:present, :absent, nil) —

  Desired state of the resource.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 90

attribute :state

#subscription ⇒ Object^?

Returns Subscription ID for azure_rm type.

Returns:

• (Object, nil) —

  Subscription ID for azure_rm type.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 68

attribute :subscription

#team ⇒ Object^?

Returns Team that should own this credential.

Returns:

• (Object, nil) —

  Team that should own this credential.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 23

attribute :team

#tenant ⇒ Object^?

Returns Tenant ID for azure_rm type.

Returns:

• (Object, nil) —

  Tenant ID for azure_rm type.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 71

attribute :tenant

#user ⇒ Object^?

Returns User that should own this credential.

Returns:

• (Object, nil) —

  User that should own this credential.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 20

attribute :user

#username ⇒ Object^?

Returns Username for this credential. access_key for AWS.

Returns:

• (Object, nil) —

  Username for this credential. access_key for AWS.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 40

attribute :username

#vault_password ⇒ Object^?

Returns Vault password. Use ASK for prompting.

Returns:

• (Object, nil) —

  Vault password. Use ASK for prompting.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_credential.rb', line 87

attribute :vault_password