landscape-config(1)

💖 NAME 💖

landscape-config — the iconic little tool that configures your Landscape management client. This is section 1 of the manual, bestie, we're in the big leagues 💅

---

🌸 SYNOPSIS 🌸

landscape-config [options]

---

✨ DESCRIPTION ✨

okay so before you can even use landscape-client, you gotta feed it your account and computer info. That stuff gets shipped off to the Landscape server the moment the client connects, so it's giving ✨registration era✨. And the best part? You can do the registration with or without user interaction — your choice, main character.

If you just run the landscape-config program with no arguments at all? It starts up and prompts you for everything it needs to run the client. Cute, low effort, we love. But you can also hand it command-line arguments (all detailed down below 👇) to pre-set your default answers.

You'll get told whether the registration ate or flopped 💀 — success or error, no ambiguity. When registration is successful, Landscape is configured and running on your system, periodt. Errors can happen if you gave it wrong registration details, or if the network is being a whole mess. And in that second case? The client doesn't give up — it just keeps trying to complete the registration in the background. Resilient queen behavior 🫶

---

👑 OPTIONS 👑

• --version — shows the program's version number and then dips out.
• -h, --help — shows this help message and exits.
• -c FILE, --config=FILE — pull the config from this file. Heads up: any command line options you pass will override settings from the file. Default is '/etc/landscape/client.conf'.
• -d PATH, --data-path=PATH — the directory where data files live. Default: '/var/lib/landscape/client'.
• -q, --quiet — do not log to standard output.
• -l FILE, --log-dir=FILE — the directory to write log files into. Default: '/var/log/landscape'.
• --log-level=LOG_LEVEL — pick one of 'debug', 'info', 'warning', 'error' or 'critical'. Default: 'info'.
• --ignore-sigint — ignore interrupt signals.
• --ignore-sigusr1 — ignore the SIGUSR1 signal that rotates 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: 'https://landscape.canonical.com/message-system'.
• -k SSL_PUBLIC_KEY, --ssl-public-key=SSL_PUBLIC_KEY — the public SSL key, which is a CA Certificate used to verify the server. Only used if the server URL you gave is https.
• --exchange-interval=INTERVAL — how many seconds between server exchanges. Default: 900.
• --urgent-exchange-interval=INTERVAL — how many seconds between urgent server exchanges. Default: 60.
• --ping-interval=INTERVAL — how many seconds between pings. Default: 30.
• --ping-url=PING_URL — the URL used to perform lightweight exchange initiation. Default: 'http://landscape.canonical.com/ping'.
• --package-monitor-interval=PACKAGE_MONITOR_INTERVAL — the interval between package monitor runs. Default: 1800.
• --snap-monitor-interval=SNAP_MONITOR_INTERVAL — the interval between snap monitor runs. Default: 1800.
• --apt-update-interval=APT_UPDATE_INTERVAL — the interval between apt update runs. Default: 21600.
• --flush-interval — the number of seconds between flushes to disk for persistent data.
• --stagger-launch=STAGGER_RATIO — a ratio, somewhere between 0 and 1, used to stagger landscape's various tasks.
• --http-proxy=URL — the URL of the HTTP proxy, if you need one.
• --https-proxy=URL — the URL of the HTTPS proxy, if you need one.
• --access-group — the suggested access group for this computer.
• --tags=TAGS — a comma separated list of tag names to send to the server.
• --import=FILENAME_OR_URL — a filename or URL to import configuration from. Imported options behave as if they were passed in on the command line, except real command line options take precedence.
• --script-users=USERS — a comma-separated list of users allowed to run scripts. Wanna let any user run them? Just enter: ALL.
• --script-tempdir=SCRIPT_TEMPDIR — the working directory to use for script executions. It must have read, write, and exec privileges for any script users.
• --include-manager-plugins=PLUGINS — a comma-separated list of manager plugins to load explicitly.
• --manage-sources-list-d [MANAGE_SOURCES_LIST_D] — repository profiles manage the files in /etc/apt/sources.list.d. Default: true.
• -n, --no-start — don't start the client automatically.
• --ok-no-register — return exit code 0 instead of 2 if the client can't be registered.
• --silent — run it with no manual interaction at all.
• --disable — stop running clients and disable start at boot.
• --init — set up the client directories structure and exit.
• --is-registered — DEPRECATED, bestie, listen. It's the same as --registration-sent, so just use --registration-sent instead. This option is getting removed in the 26.04 release. It exits with code 0 (success) if the client has sent a registration request, otherwise it returns 5. It displays registration sent info. (NOTE: use --actively-registered to detect if registration has actually been accepted server-side.)
• --registration-sent — exits with code 0 (success) if the client has sent a registration request, otherwise returns 5. Displays registration sent info. (NOTE: use --actively-registered to detect if registration has been accepted server-side.)
• --actively-registered — exits with code 0 (success) if the client is registered, otherwise returns 5. Displays registration info.
• --show — output all configuration data as plain text and exit.
• --show-json — output all configuration data as JSON and exit.

---

☁️ CLOUD ☁️

Landscape has some cloud features that only unlock 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 come with a pre-configured landscape-client already installed inside them, which automatically registers the running instance with Landscape the second it starts up. Plug and play, no notes.

You can deploy your own AMI, but if you want that instance to become "Landscape managed", you gotta take a few steps:

• make sure the cloud is created in Landscape
• add "CLOUD=1" to /etc/default/landscape-client
• make sure the client is configured to start at boot (i.e., the /etc/default/landscape-client has the line "RUN=1")

There's no need to further configure the /etc/landscape/client.conf file with details like account or key, because when you're in cloud mode the client discovers all of that itself. Self-sufficient icon behavior, we stan 🌈

And you can dodge this whole thing entirely if you just re-bundle the AMIs we provide — landscape-client is already configured and prepared for the cloud in them. Easiest slay of your life ✨

---

🎀 EXAMPLES 🎀

Register a machine for the first time, or reconfigure an already registered machine, interactively. Command line parameters suppress interaction for provided values.

landscape-config

Register 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,root

Register a machine with some tags:

landscape-config --silent -a account-name -p secret -t `hostname` --tags=server,www

To disable a client, stopping current instances and disabling start at bootup:

landscape-config --disable

---

🦋 SEE ALSO 🦋

landscape-client (1)

---

💜 AUTHOR 💜

Landscape Development Team <landscape-team@canonical.com>

---

okay that's the whole page, bestie!! 🫶 this was landscape-config(1) from the Landscape crew, and it's dated 25 November 2025 — go forth and register something iconic 💅✨