Red Hat SummitChapter 3. activation-key
Manipulate activation keys
Usage
hammer activation-key [OPTIONS] SUBCOMMAND [ARG] ...
# hammer activation-key [OPTIONS] SUBCOMMAND [ARG] ...Options
-
-h,--help– Print help
3.1. activation-key add-host-collection
Associate a resource
Usage
hammer activation-key add-host-collection [OPTIONS]
# hammer activation-key add-host-collection [OPTIONS]Options
-
--host-collection VALUE– Host collection name to search by -
--host-collection-id NUMBER– Id of the host collection -
--id VALUE– ID of the activation key -
--name VALUE– Activation key name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
-h,--help– Print help
3.2. activation-key add-subscription
Add subscription
Usage
hammer activation-key add-subscription [OPTIONS]
# hammer activation-key add-subscription [OPTIONS]Options
-
--id NUMBER– ID of the activation key -
--name VALUE– Activation key name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--quantity NUMBER– Quantity of this subscription to add -
--subscription VALUE– Subscription name to search by -
--subscription-id NUMBER– Subscription identifier -
--subscriptions SCHEMA– Array of subscriptions to add -
-h,--help– Print help
Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value):
-
--subscriptions– "id=<string>,quantity=<numeric>, … "
3.3. activation-key content-override
Override product content defaults
Usage
hammer activation-key content-override [OPTIONS]
# hammer activation-key content-override [OPTIONS]Options
-
--content-label VALUE– Label of the content -
--force– Force the override. Required for overrides other thanenabled -
--id NUMBER– ID of the activation key -
--name VALUE– Activation key name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--override-name VALUE– Override parameter key or name. To enable or disable a repo selectenabled. Default value: enabled Default: "enabled" -
--remove– Remove a content override -
--value VALUE– Override value. Note for repo enablement you can use a boolean value -
-h,--help– Print help
3.4. activation-key copy
Copy an activation key
Usage
hammer activation-key copy [OPTIONS]
# hammer activation-key copy [OPTIONS]Options
-
--id NUMBER– ID of the activation key -
--name VALUE– Activation key name to search by -
--new-name VALUE– Name of new activation key -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization identifier -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
-h,--help– Print help
3.5. activation-key create
Create an activation key
Usage
hammer activation-key create [OPTIONS]
# hammer activation-key create [OPTIONS]Options
-
--auto-attach BOOLEAN– Auto attach subscriptions upon registration -
--content-view VALUE– Content view name to search by -
--content-view-environment-ids LISTArray of content view environment ids to be associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on. -
--content-view-environments LIST– Comma-separated list of content view environment labels to be associated with the activation key, in the format oflifecycle_environment_label/content_view_label. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on. -
--content-view-id NUMBER– Id of the single content view to be associated with the activation key. -
--description VALUE– Description -
--environment VALUE– Lifecycle environment name to search by (--environment is deprecated: Use -
--lifecycle-environmentinstead) -
--environment-id NUMBER– (--environment-id is deprecated: Use--lifecycle-environment-idinstead) -
--lifecycle-environment VALUE– Lifecycle environment name to search by -
--lifecycle-environment-id NUMBER– Id of the single lifecycle environment to be associated with the activation key. -
--max-hosts NUMBER– Maximum number of registered content hosts -
--name VALUE– Name -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization identifier -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--purpose-role VALUE– Sets the system purpose usage -
--purpose-usage VALUE– Sets the system purpose usage -
--release-version VALUE– Content release version -
--service-level VALUE– Service level -
--unlimited-hosts– Set hosts max to unlimited -
-h,--help– Print help
3.6. activation-key delete
Destroy an activation key
Usage
hammer activation-key <delete|destroy> [OPTIONS]
# hammer activation-key <delete|destroy> [OPTIONS]Options
-
--id NUMBER– ID of the activation key -
--name VALUE– Activation key name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
-h,--help– Print help
3.7. activation-key host-collections
List associated host collections
Usage
hammer activation-key host-collections [OPTIONS]
# hammer activation-key host-collections [OPTIONS]Options
-
--available-for VALUE– Interpret specified object to return only Host Collections that can be associated with specified object. The valuehostis supported. -
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--full-result BOOLEAN– Whether or not to show all results -
--host-id NUMBER– Filter products by host id -
--id VALUE– ID of activation key -
--name VALUE– Name of activation key -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization identifier -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--sort-by VALUE– Field to sort the results on -
--sort-order VALUE– How to order the sorted results (e.g. ASC for ascending) -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
3.8. activation-key info
Show an activation key
Usage
hammer activation-key <info|show> [OPTIONS]
# hammer activation-key <info|show> [OPTIONS]Options
-
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--id NUMBER– ID of the activation key -
--name VALUE– Activation key name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization identifier -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--show-hosts BOOLEAN– Show hosts associated to an activation key -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Name | x | x | x |
| Id | x | x | x |
| Description | x | x | |
| Host limit | x | x | |
| Multi content view environment | x | x | |
| Release version | x | x | |
| Content view environment labels | x | x | |
| Organization/id | x | x | |
| Organization/name | x | x | |
| Content view environments/content view/id | x | x | |
| Content view environments/content view/name | x | x | |
| Content view environments/content view/version | x | x | |
| Content view environments/content view/content view version id | x | x | |
| Content view environments/content view/composite | x | x | |
| Content view environments/content view/rolling | x | x | |
| Content view environments/content view/content view environment id | x | x | |
| Content view environments/lifecycle environment/id | x | x | |
| Content view environments/lifecycle environment/name | x | x | |
| Content view environments/label | x | x | |
| Associated hosts/id | x | x | |
| Associated hosts/name | x | x | |
| Host collections/id | x | x | |
| Host collections/name | x | x | |
| Content overrides/content label | x | x | |
| Content overrides/name | x | x | |
| Content overrides/value | x | x | |
| System purpose/service level | x | x | |
| System purpose/purpose usage | x | x | |
| System purpose/purpose role | x | x |
3.9. activation-key list
List activation keys
Usage
hammer activation-key <list|index> [OPTIONS]
# hammer activation-key <list|index> [OPTIONS]Options
-
--content-view VALUE– Content view name to search by -
--content-view-environment-ids LISTArray of content view environment ids associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified.Requires allow_multiple_content_views setting to be on. -
--content-view-environments LIST– Comma-separated list of content view environment labels associated with the activation key, in the format oflifecycle_environment_label/content_view_label. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on. -
--content-view-id NUMBER– Content view identifier -
--environment VALUE– Lifecycle environment name to search by (--environment is deprecated: Use -
--lifecycle-environmentinstead) -
--environment-id NUMBER– (--environment-id is deprecated: Use--lifecycle-environment-idinstead) -
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--full-result BOOLEAN– Whether or not to show all results -
--lifecycle-environment VALUE– Lifecycle environment name to search by -
--lifecycle-environment-id NUMBER– Environment identifier -
--name VALUE– Activation key name to filter by -
--order VALUE– Sort field and order, eg.id DESC -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization identifier -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--page NUMBER– Page number, starting at 1 -
--per-page NUMBER– Number of results per page to return -
--search VALUE– Search string -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
| Host limit | x | x | |
| Content view environments | x | x | |
| Multi content view environment | x | x |
Search and order fields
-
content_view– string -
content_view_id– integer -
description– text -
environment– string -
lifecycle_environment_id– integer -
name– string -
organization_id– integer -
role– string -
subscription_id– string -
subscription_name– string -
usage– string
3.10. activation-key product-content
List associated products
Usage
hammer activation-key product-content [OPTIONS]
# hammer activation-key product-content [OPTIONS]Options
-
--content-access-mode-all BOOLEANGet all content available, not just that provided by subscriptions -
--content-access-mode-env BOOLEANLimit content to just that available in the activation key`s content view version -
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--full-result BOOLEAN– Whether or not to show all results -
--id VALUE– ID of the activation key -
--name VALUE– Activation key name to search by -
--order VALUE– Sort field and order, eg.id DESC -
--organization VALUE– Organization name to search by -
--organization-id NUMBER -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--page NUMBER– Page number, starting at 1 -
--per-page NUMBER– Number of results per page to return -
--search VALUE– Search string -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT | THIN |
|---|---|---|---|
| Id | x | x | x |
| Name | x | x | x |
| Type | x | x | |
| Url | x | x | |
| Gpg key | x | x | |
| Label | x | x | |
| Default enabled? | x | x | |
| Override | x | x |
3.11. activation-key remove-host-collection
Disassociate a resource
Usage
hammer activation-key remove-host-collection [OPTIONS]
# hammer activation-key remove-host-collection [OPTIONS]Options
-
--host-collection VALUE– Host collection name to search by -
--host-collection-id NUMBER– Id of the host collection -
--id VALUE– ID of the activation key -
--name VALUE– Activation key name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
-h,--help– Print help
3.12. activation-key remove-subscription
Remove subscription
Usage
hammer activation-key remove-subscription [OPTIONS]
# hammer activation-key remove-subscription [OPTIONS]Options
-
--id NUMBER– ID of the activation key -
--name VALUE– Activation key name to search by -
--organization VALUE– Organization name to search by -
--organization-id NUMBER -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--subscription-id VALUE– ID of subscription -
-h,--help– Print help
3.13. activation-key subscriptions
List associated subscriptions
Usage
hammer activation-key subscriptions [OPTIONS]
# hammer activation-key subscriptions [OPTIONS]Options
-
--activation-key VALUE– Activation key name to search by -
--activation-key-id VALUE– Activation key ID -
--available-for VALUE– Object to show subscriptions available for, eitherhostoractivation_key -
--fields LIST– Show specified fields or predefined field sets only. (See below) -
--full-result BOOLEAN– Whether or not to show all results -
--host VALUE– Host name -
--host-id VALUE– Id of a host -
--id VALUE– ID of the activation key -
--match-host BOOLEAN– Ignore subscriptions that are unavailable to the specified host -
--match-installed BOOLEAN– Return subscriptions that match installed products of the specified host -
--name VALUE– Activation key name to search by -
--no-overlap BOOLEAN– Return subscriptions which do not overlap with a currently-attached subscription -
--order VALUE– Sort field and order, eg.id DESC -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization ID -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--page NUMBER– Page number, starting at 1 -
--per-page NUMBER– Number of results per page to return -
--search VALUE– Search string -
-h,--help– Print help
Predefined field sets
| FIELDS | ALL | DEFAULT |
|---|---|---|
| Id | x | x |
| Name | x | x |
| Attached | x | x |
| Quantity | x | x |
| Start date | x | x |
| End date | x | x |
| Support | x | x |
| Contract | x | x |
| Account | x | x |
3.14. activation-key update
Update an activation key
Usage
hammer activation-key update [OPTIONS]
# hammer activation-key update [OPTIONS]Options
-
--auto-attach BOOLEAN– Auto attach subscriptions upon registration -
--content-view VALUE– Content view name to search by -
--content-view-environment-ids LISTArray of content view environment ids to be associated with the activation key. Ignored if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on. -
--content-view-environments LIST– Comma-separated list of content view environment labels to be associated with the activation key, in the format oflifecycle_environment_label/content_view_label. Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified. Requires allow_multiple_content_views setting to be on. -
--content-view-id NUMBER– Id of the single content view to be associated with the activation key. -
--description VALUE– Description -
--environment VALUE– Lifecycle environment name to search by (--environment is deprecated: Use -
--lifecycle-environmentinstead) -
--environment-id NUMBER– (--environment-id is deprecated: Use--lifecycle-environment-idinstead) -
--id NUMBER– ID of the activation key -
--lifecycle-environment VALUE– Lifecycle environment name to search by -
--lifecycle-environment-id NUMBER– Id of the single lifecycle environment to be associated with the activation key. -
--max-hosts NUMBER– Maximum number of registered content hosts -
--name VALUE– Name -
--new-name VALUE– Name -
--organization VALUE– Organization name to search by -
--organization-id NUMBER– Organization identifier -
--organization-label VALUE– Organization label to search by -
--organization-title VALUE– Organization title -
--purpose-role VALUE– Sets the system purpose usage -
--purpose-usage VALUE– Sets the system purpose usage -
--release-version VALUE– Content release version -
--service-level VALUE– Service level -
--unlimited-hosts– Set hosts max to unlimited -
-h,--help– Print help
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}