Fixup doc YAML

This commit is contained in:
Michael DeHaan 2013-06-06 19:21:18 -04:00
parent 6b15c871ee
commit df4c444571

View file

@ -6,11 +6,10 @@ module: subscription-manager
short_description: Manage Red Hat Network registration and subscriptions using the C(subscription-manager) command short_description: Manage Red Hat Network registration and subscriptions using the C(subscription-manager) command
description: description:
- Manage registration and subscription to the Red Hat Network entitlement platform. - Manage registration and subscription to the Red Hat Network entitlement platform.
version_added: 1.2 version_added: "1.2"
author: James Laska author: James Laska
notes: notes:
- In order to register a system, subscription-manager requires either a - In order to register a system, subscription-manager requires either a username and password, or an activationkey.
username and password, or an activationkey.
requirements: requirements:
- subscription-manager - subscription-manager
options: options:
@ -21,52 +20,50 @@ options:
choices: [ "present", "absent" ] choices: [ "present", "absent" ]
default: "present" default: "present"
username: username:
description description:
- Red Hat Network username - Red Hat Network username
required: false required: False
default: null default: null
password: password:
description: description:
- Red Hat Network password - Red Hat Network password
required: false required: False
default: null default: null
server_hostname: server_hostname:
description: description:
- Specify an alternative Red Hat Network server - Specify an alternative Red Hat Network server
required: false required: False
default: Current value from C(/etc/rhsm/rhsm.conf) is the default default: Current value from C(/etc/rhsm/rhsm.conf) is the default
server_insecure: server_insecure:
description: description:
- Allow traffic over insecure http - Allow traffic over insecure http
required: false required: False
default: Current value from C(/etc/rhsm/rhsm.conf) is the default default: Current value from C(/etc/rhsm/rhsm.conf) is the default
rhsm_baseurl: rhsm_baseurl:
description: description:
- Specify CDN baseurl - Specify CDN baseurl
required: false required: False
default: Current value from C(/etc/rhsm/rhsm.conf) is the default default: Current value from C(/etc/rhsm/rhsm.conf) is the default
autosubscribe: autosubscribe:
description: description:
- Upon successful registration, auto-consume available - Upon successful registration, auto-consume available subscriptions
subscriptions required: False
required: false default: False
default: false
activationkey: activationkey:
description: description:
- supply an activation key for use with registration - supply an activation key for use with registration
required: false required: False
default: null default: null
pool: pool:
description: description:
- Specify a subscription pool name to consume. Regular expressions - Specify a subscription pool name to consume. Regular expressions accepted.
accepted. required: False
required: false
default: '^$' default: '^$'
examples: examples:
- code: subscription_manager action=register username=joe_user password=somepass autosubscribe=true - code: subscription_manager action=register username=joe_user password=somepass autosubscribe=true
- description: Register as user I(joe_user) with password I(somepass) and auto-subscribe to available content. description: Register as user I(joe_user) with password I(somepass) and auto-subscribe to available content.
- code: subscription_manager action=register activationkey=1-222333444 pool='^(Red Hat Enterprise Server|Red Hat Virtualization)$' - code: subscription_manager action=register activationkey=1-222333444 pool='^(Red Hat Enterprise Server|Red Hat Virtualization)$'
- description: Register with activationkey I(1-222333444) and consume subscriptions matching the names I(Red hat Enterprise Server) and I(Red Hat Virtualization) description: Register with activationkey I(1-222333444) and consume subscriptions matching the names I(Red hat Enterprise Server) and I(Red Hat Virtualization)
''' '''
import os import os