Text automatically generated by txt2man
NAMElandscape-config - configure the Landscape management client
Before using the landscape-client it must be configured with account and computer information that is transmitted to the Landscape server when the client connects. The registration can be performed with or without user interaction.
Running the landscape-config program without arguments will start the program, prompting you for the necessary information to run the client. Optionally you can provide command-line arguments (detailed below) to specify default responses.
You will be told if the registration was successful or if an error occurred. When registration is successful Landscape is configured and running on your system. Errors can occur if you provide incorrect registration details or if there are network issues. In the latter case, the client will keep trying to complete the registration in the background.
- Show program's version number and exit.
- -h, --help
- Show this help message and exit.
- -c FILE, --config=FILE
- Use config from this file (any command line options override settings from the file) (default: '/etc/landscape/client.conf').
- -d PATH, --data-path=PATH
- The directory to store data files in (default: '/var/lib/landscape/client').
- -q, --quiet
- Do not log to the standard output.
- -l FILE, --log-dir=FILE
- The directory to write log files to (default: '/var/log/landscape').
- One of 'debug', 'info', 'warning', 'error' or 'critical' (default: 'info').
- Ignore interrupt signals.
- Ignore SIGUSR1 signal to rotate logs.
- -a NAME, --account-name=NAME
- The account this computer belongs to.
- -p KEY, --registration-key=KEY
- The account-wide key used for registering clients.
- -t TITLE, --computer-title=TITLE
- The title of this computer.
- -u URL, --url=URL
- The server URL to connect to (default: 'landscape.canonical.com/message-system
- -k SSL_PUBLIC_KEY, --ssl-public-key=SSL_PUBLIC_KEY
- The SSL CA certificate to verify the server with. Only used if the server URL to which we connect is https.
- The number of seconds between server exchanges (default: 900).
- The number of seconds between urgent server exchanges (default: 60).
- The number of seconds between pings (default: 30).
- The URL to perform lightweight exchange initiation with (default: 'landscape.canonical.com/ping
- The interval between package monitor runs (default: 1800).
- The interval between apt update runs (default: 21600).
- The URL of the HTTP proxy, if one is needed.
- The URL of the HTTPS proxy, if one is needed.
- Set this if this computer is a cloud instance in EC2 or UEC. Read below for details.
- Comma separated list of tag names to be sent to the server.
- Filename or URL to import configuration from. Imported options behave as if they were passed in the command line, with precedence being given to real command line options.
- A comma-separated list of users to allow scripts to run. To allow scripts to be run by any user, enter: ALL.
- A comma-separated list of manager plugins to load explicitly.
- -n, --no-start
- Don't start the client automatically.
- Return exit code 0 instead of 2 if the client can't be registered.
- Run without manual interaction.
- Stop running clients and disable start at boot.
- The one-time password (OTP) to use in cloud configuration.
Landscape has some cloud features that become available when the EC2 or UEC machine instance was started using Landscape and the AMI is one of the official ones provided in the Web user interface. We call these instances "Landscape enabled", because they contain a pre-configured landscape-client installed in them which will register the running instance automatically with Landscape as soon as it starts up.
You can deploy your own AMI, but if you wish the instance to become "Landscape managed" you need to take a few steps:
- make sure the cloud is created in Landscape
- either add "CLOUD=1" to /etc/default/landscape-client or use the --cloud switch in the landscape-config(1) command line
- make sure the client is configured to start at boot (i.e., the /etc/default/landscape-client has the line "RUN=1")
There is no need to further configure the /etc/landscape/client.conf file with details such as account or key, because when in cloud mode this is all discovered by the client itself.
You can avoid this all if you just re-bundle the AMIs we provide. landscape-client is already configured and prepared for the cloud in them.
Register a machine for the first time, or reconfigure an already registered machine, interactively. Command line parameters suppress interaction for provided values.
landscape-configRegister a machine for the first time, or reconfigure an already registered machine, without requiring user interaction. The client will be configured to start on boot automatically:
landscape-config --silent -a account-name -p secret -t `hostname`Register a machine with the script execution plugin enabled, without requiring user interaction:
landscape-config --silent -a account-name -p secret -t `hostname` --script-users nobody,landscape,rootRegister a machine with some tags:
landscape-config --silent -a account-name -p secret -t `hostname` --tags=server,wwwTo disable a client, stopping current instances and disabling start at bootup: