~ahasenack/landscape-client/landscape-client-11.02-0ubuntu0.9.10.1

« back to all changes in this revision

Viewing changes to man/landscape-config.txt

  • Committer: Bazaar Package Importer
  • Author(s): Free Ekanayaka
  • Date: 2010-02-10 18:49:25 UTC
  • mfrom: (1.2.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20100210184925-di1svw11f8d8oexz
Tags: 1.4.4-0ubuntu0.9.10
* New upstream release (LP: #519200):
  - Add a message for creating package locks (LP: #514334)
  - Add support for auto-approved change-packages messages (LP: #517175)
  - Add support for installing server-generated debian packages (LP: #509752)
  - Add support for reporting Eucalyptus topology information (LP: #518501)
  - Fix timeout while inserting large free-space message (LP: #218388)
  - Fix wrong log path in motd (LP: #517454)
  - Fix race condition in process excecution (LP: #517453)

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
  landscape-config - configure the Landscape management client
3
3
 
4
4
SYNOPSIS
5
 
  landscape-config [--silent, -a ACCOUNT, -t TITLE, -p PASSWORD, -l LOG,
6
 
                    -k KEY, -d PATH]
 
5
  landscape-config [options]
7
6
 
8
7
DESCRIPTION
9
8
 
15
14
Running the landscape-config program without arguments will start the
16
15
program, prompting you for the necessary information to run the client.
17
16
Optionally you can provide command-line arguments (detailed below) to
18
 
specify default responses. You will be told if the registration was
19
 
successful or if an error occurred. When registration is successful
20
 
Landscape is configured and running on your system. Errors can occur if
21
 
you provide incorrect registration details.
 
17
specify default responses.
 
18
 
 
19
You will be told if the registration was successful or if an error occurred.
 
20
When registration is successful Landscape is configured and running on your
 
21
system. Errors can occur if you provide incorrect registration details or if
 
22
there are network issues. In the latter case, the client will keep trying
 
23
to complete the registration in the background.
22
24
 
23
25
OPTIONS
24
 
 --version                                   show program's version number and exit
25
 
 -h, --help                                  show this help message and exit
26
 
 -c FILE, --config=FILE                      Use config from this file (any command line options override settings from the file)
27
 
 --bus=BUS                                   The DBUS bus to use. One of 'session' or 'system'
28
 
 -d PATH, --data-path=PATH                   The directory to store data files in
29
 
 -q, --quiet                                 Do not log to the standard output
30
 
 -l FILE, --log-dir=FILE                     The directory to write log files to
31
 
 --log-level=LOG_LEVEL                       One of debug, info, warning, error or critical
32
 
 --ignore-sigint                             Ignore interrupt signals
33
 
 -a NAME, --account-name=NAME                The account this computer belongs to
34
 
 -p SECRET, --registration-password=SECRET   The account-wide password used for registering clients
35
 
 -t TITLE, --computer-title=TITLE            The title of this computer
36
 
 --script-users=USERS                        A comma-separated list of users to allow scripts to run. To allow scripts to be run by any user, enter ALL
37
 
 --include-manager-plugins=PLUGINS           A comma-separated list of manager plugins to load
38
 
 -u URL, --url=URL                           The server URL to connect to
39
 
 -k SSL_KEY, --ssl-public-key=SSL_KEY        The public SSL key to verify the server, only used if the given URL is https
40
 
 --exchange-interval=INTERVAL                The number of seconds between server exchanges
41
 
 --urgent-exchange-interval=INTERVAL         The number of seconds between urgent server exchanges
42
 
 --ping-url=PING_URL                         The URL to perform lightweight exchange initiation with
43
 
 --http-proxy=URL                            The URL of the HTTP proxy, if one is needed
44
 
 --https-proxy=URL                           The URL of the HTTPS proxy, if one is needed
45
 
 -n, --no-start                              Don't start the client automatically
46
 
 --silent                                    Run without manual interaction
47
 
 --disable                                   Stop running clients and disable start at boot
48
 
 
 
26
  --version                Show program's version number and exit.
 
27
  -h, --help               Show this help message and exit.
 
28
  -c FILE, --config=FILE   Use config from this file (any command line options
 
29
                           override settings from the file) (default:
 
30
                           '/etc/landscape/client.conf').
 
31
  --bus=BUS                Which DBUS bus to use. One of 'session' or 'system'
 
32
                           (default: 'system').
 
33
  -d PATH, --data-path=PATH   The directory to store data files in (default:
 
34
                           '/var/lib/landscape/client').
 
35
  -q, --quiet              Do not log to the standard output.
 
36
  -l FILE, --log-dir=FILE   The directory to write log files to (default:
 
37
                           '/var/log/landscape').
 
38
  --log-level=LOG_LEVEL    One of 'debug', 'info', 'warning', 'error' or 
 
39
                           'critical' (default: 'info').
 
40
  --ignore-sigint          Ignore interrupt signals.
 
41
  --ignore-sigusr1         Ignore SIGUSR1 signal to rotate logs.
 
42
  -a NAME, --account-name=NAME   The account this computer belongs to.
 
43
  -p PASSWORD, --registration-password=PASSWORD  The account-wide password 
 
44
                           used for registering clients.
 
45
  -t TITLE, --computer-title=TITLE   The title of this computer.
 
46
  -u URL, --url=URL        The server URL to connect to (default:
 
47
                           'https://landscape.canonical.com/message-system').
 
48
  -k SSL_PUBLIC_KEY, --ssl-public-key=SSL_PUBLIC_KEY   The SSL CA certificate to 
 
49
                           verify the server with. Only used if the server URL
 
50
                           to which we connect is https.
 
51
  --exchange-interval=INTERVAL   The number of seconds between server
 
52
                           exchanges (default: 900).
 
53
  --urgent-exchange-interval=INTERVAL   The number of seconds between urgent
 
54
                           server exchanges (default: 60).
 
55
  --ping-url=PING_URL      The URL to perform lightweight exchange initiation
 
56
                           with.
 
57
                           (default: 'http://landscape.canonical.com/ping').
 
58
  --http-proxy=URL         The URL of the HTTP proxy, if one is needed.
 
59
  --https-proxy=URL        The URL of the HTTPS proxy, if one is needed.
 
60
  --cloud                  Set this if this computer is a cloud instance in
 
61
                           EC2 or UEC. Read below for details.
 
62
  --tags=TAGS              Comma separated list of tag names to be sent to the
 
63
                           server.
 
64
  --import=FILENAME_OR_URL   Filename or URL to import configuration from.
 
65
                           Imported options behave as if they were passed in
 
66
                           the command line, with precedence being given to
 
67
                           real command line options.
 
68
  --script-users=USERS     A comma-separated list of users to allow scripts to
 
69
                           run. To allow scripts to be run by any user, 
 
70
                           enter: ALL.
 
71
  --include-manager-plugins=PLUGINS   A comma-separated list of manager 
 
72
                           plugins to load.
 
73
  -n, --no-start           Don't start the client automatically.
 
74
  --ok-no-register         Return exit code 0 instead of 2 if the client can't be
 
75
                           registered.
 
76
  --silent                 Run without manual interaction.
 
77
  --disable                Stop running clients and disable start at boot.
 
78
 
 
79
CLOUD
 
80
 
 
81
Landscape has some cloud features that become available when the EC2 or
 
82
UEC machine instance was started using Landscape and the AMI is one of
 
83
the official ones provided in the Web user interface. We call these 
 
84
instances "Landscape enabled", because they contain a pre-configured
 
85
landscape-client installed in them which will register the running instance
 
86
automatically with Landscape as soon as it starts up.
 
87
 
 
88
You can deploy your own AMI, but if you wish the instance to become
 
89
"Landscape managed" you need to take a few steps:
 
90
* make sure the cloud is created in Landscape
 
91
* either add "CLOUD=1" to /etc/default/landscape-client or use the
 
92
--cloud switch in the landscape-config(1) command line
 
93
* make sure the client is configured to start at boot (i.e., the
 
94
/etc/default/landscape-client has the line "RUN=1")
 
95
 
 
96
There is no need to further configure the /etc/landscape/client.conf file
 
97
with details such as account or password, because when in cloud mode
 
98
this is all discovered by the client itself.
 
99
 
 
100
You can avoid this all if you just rebundle the AMIs we provide.
 
101
landscape-client is already configured and prepared for the cloud in
 
102
them.
49
103
 
50
104
EXAMPLES
51
105
 
66
120
 
67
121
  landscape-config --silent -a account-name -p secret -t `hostname` --script-users nobody,landscape,root
68
122
 
 
123
Register a machine with some tags:
 
124
 
 
125
  landscape-config --silent -a account-name -p secret -t `hostname` --tags=server,www
 
126
 
69
127
To disable a client, stopping current instances and disabling start at
70
128
bootup:
71
129