rhsm_register

[edit on GitHub]

Use the rhsm_register resource to register a node with the Red Hat Subscription Manager or a local Red Hat Satellite server.

New in Chef Client 14.0.

Syntax

This resource has the following syntax:

rhsm_register 'name' do
  activation_key             String, Array
  auto_attach                True, False # default value: 'false'
  environment                String
  force                      True, False # default value: 'false'
  install_katello_agent      True, False # default value: 'true'
  notifies                   # see description
  organization               String
  password                   String
  satellite_host             String
  subscribes                 # see description
  action                     Symbol # defaults to :register if not specified
end

where:

  • rhsm_register is the resource
  • 'name' is the RHSM Satellite server name, or the resource name
  • activation_key, auto_attach, environment, force, install_katello_agent, notifies, organization, password, satellite_host, and subscribes are the properties available to this resource

Actions

:register
Default. Register the node with RHSM.
:unregister
Unregister the node from RHSM.
:nothing
Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the Chef Client run.

Properties

activation_key

Ruby Types: String, Array

A string or array of activation keys to use when registering; you must also specify the organization property when using this.

auto_attach

Ruby Type: True, False | Default Value: false

If true, RHSM will attempt to automatically attach the host to applicable subscriptions. It is generally better to use an activation key with the subscriptions predefined.

environment

Ruby Type: String

The environment to use when registering; required when using the username and password properties.

force

Ruby Type: True, False | Default Value: false

If true, the system will be registered even if it is already registered. Normally, any register operations will fail if the machine has already been registered.

install_katello_agent

Ruby Type: True, False | Default Value: true

If true, the katello-agent RPM will be installed.

notifies

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may notify another resource to take action when its state changes. Specify a 'resource[name]', the :action that resource should take, and then the :timer for that action. A resource may notify more than one resource; use a notifies statement for each resource to be notified.

A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:

:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the very end of the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for notifies is:

notifies :action, 'resource[name]', :timer
organization

Ruby Type: String

The organization to use when registering; required when using the activation_key property.

password

Ruby Type: String

The password to use when registering. This property is not applicable if using an activation key. If specified, username and environment are also required.

satellite_host

Ruby Type: String

The FQDN of the Satellite host to register with. If this property is not specified, the host will register with Red Hat’s public RHSM service.

subscribes

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a 'resource[name]', the :action to be taken, and then the :timer for that action.

Note that subscribes does not apply the specified action to the resource that it listens to - for example:

file '/etc/nginx/ssl/example.crt' do
   mode '0600'
   owner 'root'
end

service 'nginx' do
   subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

In this case the subscribes property reloads the nginx service whenever its certificate file, located under /etc/nginx/ssl/example.crt, is updated. subscribes does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the :reload action for its resource (in this example nginx) when a change is detected.

A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:

:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the very end of the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for subscribes is:

subscribes :action, 'resource[name]', :timer