Skip to content

Commit 8f03efa

Browse files
committed
document the filtering of unsupported options
1 parent 1a905fe commit 8f03efa

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,10 @@ rhsm_register { 'subscription.rhn.example.com':
285285
Please see man(5) RHSM.CONF for your locally supported options. There are quite
286286
a few and they require specific inputs.
287287

288+
rhsm_config cannot set values that are not available from the `subscription-manager config` sub-command.
289+
290+
For the rhsm.conf options that are not supported directly, it is recommended to use either the puppetlabs-stdlib `file_line` or one of the many forge.puppet.com modules for managing ini-format files.
291+
288292
##### rhsm_config options
289293

290294
See the documentation at [RedHat Support](https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/rhsm-config.html#tab.rhsm.conf-parameters) for RedHat provided details on the `/etc/rhsm/rhsm.conf` file.
@@ -301,9 +305,13 @@ The most important settings are as follows. Specific support is made for them.
301305
Other options can be rolled into a configuration hash and fed to the module as a
302306
whole. See init.pp and the following YAML example for details.
303307

308+
Do know the supported options to the specific version of `subscription-manager config --help` on your platform.
309+
310+
***Options that are not supported will be ignored!***
311+
304312
##### rhsm_config Examples
305313

306-
As a resource.
314+
As a resource, the format of `[section]` and `section.key` is transformed into the puppet language compatible `section_key`.
307315

308316
```puppet
309317
rhsm_config { 'katello.example.com':

0 commit comments

Comments
 (0)