1SYSPURPOSE(8)               System Manager's Manual              SYSPURPOSE(8)
2
3
4

NAME

6       syspurpose - Set the intended purpose for this system
7

SYNOPSIS

9       syspurpose [COMMAND] [OPTION]...
10
11

DESCRIPTION

13       Syspurpose  is a utility for viewing and modifying system purpose prop‐
14       erties.
15
16       The properties (hints) set by syspurpose are passed to a Red  Hat  sub‐
17       scription  management  entitlement server (Customer Portal or Satellite
18       6) to help attach the most  appropriate  subscriptions  to  the  system
19       automatically. The entitlement server also reports whether the attached
20       subscriptions match the specified  system  purpose.  Satisfying  system
21       purpose  properties  depends greatly on the quantity, availability, and
22       subscription SKU offerings that have been purchased for  the  organiza‐
23       tion that the system is registered to.
24
25       The  set,  unset,  add,  and remove subcommands modify the local system
26       purpose, and when possible will report the updated settings to the  Red
27       Hat  subscription  management  entitlement  server  (Customer Portal or
28       Satellite 6).  The show command displays the current system purpose.
29
30

COMMANDS

32       syspurpose set-role VALUE
33              Set the role property
34
35       syspurpose unset-role VALUE
36              Clear the role property
37
38       syspurpose set-sla VALUE
39              Set the service level agreement property
40
41       syspurpose unset-sla VALUE
42              Clear the service level agreement property
43
44       syspurpose set-usage VALUE
45              Set the system usage property
46
47       syspurpose unset-usage VALUE
48              Clear the system usage property
49
50       syspurpose add-addons VALUE...
51              Add values to the add-ons property
52
53       syspurpose remove-addons VALUE...
54              Remove values from the add-ons property
55
56       syspurpose show VALUE
57              Show the current system purpose properties
58
59   Generic Commands
60       The following generic commands can be used as well
61
62       syspurpose set PROPERTY VALUE
63              Set the value for a specific property. E.g. syspurpose set usage
64              foo is functionally identical to syspurpose set-usage foo.
65
66       syspurpose unset PROPERTY
67              Clears  the value for a specific property. E.g. syspurpose unset
68              foo is functionally identical to syspurpose unset-usage.
69
70       syspurpose add PROPERTY VALUE
71              Add a value to a specific list  property.  E.g.  syspurpose  add
72              addons foo bar is identical to syspurpose add-addons foo bar.
73
74       syspurpose remove PROPERTY VALUE
75              Clear  a  value  from  a specific list property. E.g. syspurpose
76              remove addons foo bar is identical to  syspurpose  remove-addons
77              foo bar.
78
79              Only  "addons"  acts  as  a list property.  The other properties
80              only accept a single value.
81
82

OPTIONS

84       --help Display a summary of the available commands
85
86

EXAMPLES

88       syspurpose set-role "RHEL Server"
89              Indicate that this system should consume a RHEL Server subscrip‐
90              tion:
91
92       syspurpose unset-role
93              Clear a previously set role
94
95

BUGS

97       This tool is part of Red Hat Subscription Manager. To file bugs against
98       this command-line tool, go to <https://bugzilla.redhat.com>, and select
99       Red Hat > Red Hat Enterprise Linux > subscription-manager.
100
101

AUTHOR

103       Chris Snyder <csnyder@redhat.com>
104
105

107       Copyright © 2018 Red Hat, Inc.
108
109
110
111                                                                 SYSPURPOSE(8)
Impressum