Class: Ansible::Ruby::Modules::Redhat_subscription

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb

Overview

Manage registration and subscription to the Red Hat Subscription Management entitlement platform using the C(subscription-manager) command

Instance Method Summary collapse

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

#activationkey ⇒ String?

Returns supply an activation key for use with registration.

Returns:

  • (String, nil) —

    supply an activation key for use with registration



52
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 52

attribute :activationkey

#auto_attach ⇒ :yes, ...

Returns Upon successful registration, auto-consume available subscriptions,Added in favor of deprecated autosubscribe in 2.5.

Returns:

  • (:yes, :no, nil) —

    Upon successful registration, auto-consume available subscriptions,Added in favor of deprecated autosubscribe in 2.5.



48
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 48

attribute :auto_attach

#consumer_id ⇒ String?

Returns References an existing consumer ID to resume using a previous registrationrnfor this system. If the system’s identity certificate is lost or corrupted,rnthis option allows it to resume using its previous identity and subscriptions.rnThe default is to not specify a consumer ID so a new ID is created.rn.

Returns:

  • (String, nil) —

    References an existing consumer ID to resume using a previous registrationrnfor this system. If the system’s identity certificate is lost or corrupted,rnthis option allows it to resume using its previous identity and subscriptions.rnThe default is to not specify a consumer ID so a new ID is created.rn



77
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 77

attribute :consumer_id

#consumer_name ⇒ Object?

Returns Name of the system to register, defaults to the hostname.

Returns:

  • (Object, nil) —

    Name of the system to register, defaults to the hostname



74
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 74

attribute :consumer_name

#consumer_type ⇒ Object?

Returns The type of unit to register, defaults to system.

Returns:

  • (Object, nil) —

    The type of unit to register, defaults to system



71
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 71

attribute :consumer_type

#environment ⇒ String?

Returns Register with a specific environment in the destination org. Used with Red Hat Satellite 6.x or Katello.

Returns:

  • (String, nil) —

    Register with a specific environment in the destination org. Used with Red Hat Satellite 6.x or Katello



60
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 60

attribute :environment

#force_register ⇒ :yes, ...

Returns Register the system even if it is already registered.

Returns:

  • (:yes, :no, nil) —

    Register the system even if it is already registered



81
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 81

attribute :force_register

#org_id ⇒ Integer?

Returns Organization ID to use in conjunction with activationkey.

Returns:

  • (Integer, nil) —

    Organization ID to use in conjunction with activationkey



56
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 56

attribute :org_id

#password ⇒ String?

Returns access.redhat.com or Sat6 password.

Returns:

  • (String, nil) —

    access.redhat.com or Sat6 password



20
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 20

attribute :password

#pool ⇒ String?

Returns Specify a subscription pool name to consume. Regular expressions accepted. Use I(pool_ids) instead ifrnpossible, as it is much faster. Mutually exclusive with I(pool_ids).rn.

Returns:

  • (String, nil) —

    Specify a subscription pool name to consume. Regular expressions accepted. Use I(pool_ids) instead ifrnpossible, as it is much faster. Mutually exclusive with I(pool_ids).rn



64
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 64

attribute :pool

#pool_ids ⇒ Object?

Returns Specify subscription pool IDs to consume. Prefer over I(pool) when possible as it is much faster.rnA pool ID may be specified as a C(string) - just the pool ID (ex. C(0123456789abcdef0123456789abcdef)),rnor as a C(dict) with the pool ID as the key, and a quantity as the value (ex.rnC(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiplernentitlements from a pool (the pool must support this). Mutually exclusive with I(pool).rn.

Returns:

  • (Object, nil) —

    Specify subscription pool IDs to consume. Prefer over I(pool) when possible as it is much faster.rnA pool ID may be specified as a C(string) - just the pool ID (ex. C(0123456789abcdef0123456789abcdef)),rnor as a C(dict) with the pool ID as the key, and a quantity as the value (ex.rnC(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiplernentitlements from a pool (the pool must support this). Mutually exclusive with I(pool).rn



68
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 68

attribute :pool_ids

#rhsm_baseurl ⇒ Object?

Returns Specify CDN baseurl.

Returns:

  • (Object, nil) —

    Specify CDN baseurl



30
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 30

attribute :rhsm_baseurl

#rhsm_repo_ca_cert ⇒ Object?

Returns Specify an alternative location for a CA certificate for CDN.

Returns:

  • (Object, nil) —

    Specify an alternative location for a CA certificate for CDN



33
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 33

attribute :rhsm_repo_ca_cert

#server_hostname ⇒ Object?

Returns Specify an alternative Red Hat Subscription Management or Sat6 server.

Returns:

  • (Object, nil) —

    Specify an alternative Red Hat Subscription Management or Sat6 server



24
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 24

attribute :server_hostname

#server_insecure ⇒ Object?

Returns Enable or disable https server certificate verification when connecting to C(server_hostname).

Returns:

  • (Object, nil) —

    Enable or disable https server certificate verification when connecting to C(server_hostname)



27
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 27

attribute :server_insecure

#server_proxy_hostname ⇒ Object?

Returns Specify a HTTP proxy hostname.

Returns:

  • (Object, nil) —

    Specify a HTTP proxy hostname



36
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 36

attribute :server_proxy_hostname

#server_proxy_password ⇒ Object?

Returns Specify a password for HTTP proxy with basic authentication.

Returns:

  • (Object, nil) —

    Specify a password for HTTP proxy with basic authentication



45
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 45

attribute :server_proxy_password

#server_proxy_port ⇒ Object?

Returns Specify a HTTP proxy port.

Returns:

  • (Object, nil) —

    Specify a HTTP proxy port



39
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 39

attribute :server_proxy_port

#server_proxy_user ⇒ Object?

Returns Specify a user for HTTP proxy with basic authentication.

Returns:

  • (Object, nil) —

    Specify a user for HTTP proxy with basic authentication



42
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 42

attribute :server_proxy_user

#state ⇒ :present, ...

Returns whether to register and subscribe (C(present)), or unregister (C(absent)) a system.

Returns:

  • (:present, :absent, nil) —

    whether to register and subscribe (C(present)), or unregister (C(absent)) a system



12
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 12

attribute :state

#username ⇒ String?

Returns access.redhat.com or Sat6 username.

Returns:

  • (String, nil) —

    access.redhat.com or Sat6 username



16
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/redhat_subscription.rb', line 16

attribute :username