258 lines
7.1 KiB
HTML
258 lines
7.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of UBUNTU-ADVANTAGE</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>UBUNTU-ADVANTAGE</H1>
|
|
Section: Ubuntu Advantage (1)<BR>Updated: 21 February 2020<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
ubuntu-advantage - Manage Ubuntu Advantage services from Canonical
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>ua</B> <command> [<args>]
|
|
|
|
<BR>
|
|
|
|
<B>ubuntu-advantage</B> <command> [<args>]
|
|
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
Ubuntu Advantage is a collection of services offered by Canonical to
|
|
Ubuntu users. The Ubuntu Advantage command line tool is used to attach
|
|
a system to an Ubuntu Advantage contract to then enable and disable
|
|
services from Canonical. The available commands and services are
|
|
described in more detail below.
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>COMMANDS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>attach</B> [--no-auto-enable] <token>
|
|
|
|
<DD>
|
|
Connect an Ubuntu Advantage support contract to this machine.
|
|
<P>
|
|
The <I>token</I> parameter can be obtained from
|
|
<A HREF="https://auth.contracts.canonical.com/.">https://auth.contracts.canonical.com/.</A>
|
|
<P>
|
|
The optional <I>--no-auto-enable</I> flag will disable the automatic
|
|
enablement of recommended entitlements which usually happens immediately
|
|
after a successful attach.
|
|
<P>
|
|
<DT id="2"><B>detach</B>
|
|
|
|
<DD>
|
|
Remove the Ubuntu Advantage support contract from this machine. This
|
|
also disables all enabled services that can be.
|
|
<P>
|
|
<DT id="3"><B>disable</B> [cc-eal|cis-audit|esm|fips|fips-updates|livepatch]
|
|
|
|
<DD>
|
|
Disable this machine's access to an Ubuntu Advantage service.
|
|
<P>
|
|
<DT id="4"><B>enable</B> [cc-eal|cis-audit|esm|fips|fips-updates|livepatch]
|
|
|
|
<DD>
|
|
Activate and configure this machine's access to an Ubuntu Advantage
|
|
service.
|
|
<P>
|
|
<DT id="5"><B>refresh</B>
|
|
|
|
<DD>
|
|
Refresh contract and service details from Canonical.
|
|
<P>
|
|
<DT id="6"><B>status</B> [--format=tabular|json]
|
|
|
|
<DD>
|
|
Report current status of Ubuntu Advantage services on system.
|
|
<P>
|
|
This shows whether this machine is attached to an Ubuntu Advantage
|
|
support contract. When attached, the report includes the specific
|
|
support contract details including contract name, expiry dates, and the
|
|
status of each service on this system.
|
|
<P>
|
|
The attached status output has four columns:
|
|
<P>
|
|
<B>SERVICE</B>:
|
|
|
|
name of the service
|
|
<P>
|
|
<B>ENTITLED</B>:
|
|
|
|
whether the contract to which this machine is attached entitles use of
|
|
this service. Possible values are: <I>yes</I> or <I>no</I>
|
|
<P>
|
|
<B>STATUS</B>:
|
|
|
|
whether the service is enabled on this machine.
|
|
Possible values are: <I>enabled</I>, <I>disabled</I>, <I>n/a</I> (if your
|
|
contract entitles you to the service, but it isn't available for this
|
|
machine) or <I>—</I> (if you aren't entitled to this service)
|
|
<P>
|
|
<B>DESCRIPTION</B>:
|
|
|
|
a brief description of the service
|
|
<P>
|
|
The unattached status output instead has three columns. <B>SERVICE</B>
|
|
and <B>DESCRIPTION</B> are the same as above, and there is the addition
|
|
of:
|
|
<P>
|
|
<B>AVAILABLE</B>:
|
|
|
|
whether this service would be available if this machine were attached.
|
|
The possible values are <I>yes</I> or <I>no</I>.
|
|
<P>
|
|
<DT id="7"><B>version</B>
|
|
|
|
<DD>
|
|
Show version of the Ubuntu Advantage package.
|
|
<P>
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CONFIGURATION</H2>
|
|
|
|
By default, Ubuntu Advantage client configuration options are read from
|
|
<B>/etc/ubuntu-advantage/uaclient.conf.
|
|
<P>
|
|
The following configuration options are available:
|
|
<DL COMPACT>
|
|
<DT id="8">contract_url</B>
|
|
|
|
<DD>
|
|
The ubuntu advantage contract server URL
|
|
<DT id="9"><B>data_dir</B>
|
|
|
|
<DD>
|
|
Where Ubuntu Advantage client stores its data files
|
|
<DT id="10"><B>log_level</B>
|
|
|
|
<DD>
|
|
The logging level used when writing to <B>log_file</B>
|
|
<DT id="11"><B>log_file</B>
|
|
|
|
<DD>
|
|
The log file for the Ubuntu Advantage client
|
|
<P>
|
|
</DL>
|
|
<P>
|
|
|
|
Additionally, any configuration option can be overridden in the environment
|
|
by setting an environment variable prefaced by <B>UA_<option_name></B>. Both
|
|
uppercase and lowercase environment variables are allowed.
|
|
<P>
|
|
For example, the following overrides the log_level found in uaclient.conf:
|
|
<P>
|
|
|
|
<PRE>
|
|
UA_LOG_LEVEL=info ua attach
|
|
</PRE>
|
|
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SERVICES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="12"><B>Common Criteria EAL2 Provisioning (cc-eal)</B>
|
|
|
|
<DD>
|
|
Enables and install the Common Criteria artifacts.
|
|
<P>
|
|
The artifacts include a configure script, a tarball with additional
|
|
packages, and post install scripts. The artifacts will be installed in
|
|
/usr/lib/common-criteria directory and the README and configuration
|
|
guide are available in /usr/share/doc/ubuntu-commoncriteria directory.
|
|
<P>
|
|
<DT id="13"><B>CIS Audit (cis-audit)</B>
|
|
|
|
<DD>
|
|
Enables and installs the CIS Audit artifacts.
|
|
<P>
|
|
<DT id="14"><B>Extended Security Maintenance (esm)</B>
|
|
|
|
<DD>
|
|
Extended Security Maintenance ensures the ongoing security and
|
|
integrity of systems running Ubuntu Long Term Support (LTS) releases
|
|
through Ubuntu Advantage for Infrastructure.
|
|
<P>
|
|
See <A HREF="https://ubuntu.com/esm">https://ubuntu.com/esm</A> for more information.
|
|
<P>
|
|
<DT id="15"><B>FIPS 140-2 certified modules (fips)</B>
|
|
|
|
<DD>
|
|
Install, configure, and enable FIPS 140-2 certified modules.
|
|
<P>
|
|
After successfully enabling FIPS, the system MUST be rebooted. Failing
|
|
to reboot will result in the system not running the updated FIPS
|
|
kernel.
|
|
<P>
|
|
Disabling FIPS is not currently supported.
|
|
<P>
|
|
<DT id="16"><B>FIPS 140-2 certified modules with updates (fips-updates)</B>
|
|
|
|
<DD>
|
|
Install, configure, and enable FIPS 140-2 certified modules with
|
|
updates. Enabling FIPS with updates will take the system out of FIPS
|
|
compliance as the updated modules are not FIPS certified.
|
|
<P>
|
|
After successfully enabling FIPS with updates, the system MUST be
|
|
rebooted. Failing to reboot will result in the system not running the
|
|
updated FIPS kernel.
|
|
<P>
|
|
Disabling FIPS with updates is not currently supported.
|
|
<P>
|
|
<DT id="17"><B>Livepatch Service (livepatch)</B>
|
|
|
|
<DD>
|
|
Automatically apply critical kernel patches without rebooting. Reduces
|
|
downtime, keeping your Ubuntu LTS systems secure and compliant.
|
|
<P>
|
|
See <A HREF="https://ubuntu.com/livepatch">https://ubuntu.com/livepatch</A> for more information.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>REPORTING BUGS</H2>
|
|
|
|
Please report bugs either by running `ubuntu-bug ubuntu-advantage-tools` or
|
|
login to Launchpad and navigate to
|
|
<A HREF="https://bugs.launchpad.net/ubuntu/+source/ubuntu-advantage-tools/+filebug">https://bugs.launchpad.net/ubuntu/+source/ubuntu-advantage-tools/+filebug</A>
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
Copyright (C) 2019-2020 Canonical Ltd.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="18"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="19"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="20"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="21"><A HREF="#lbAE">COMMANDS</A><DD>
|
|
<DT id="22"><A HREF="#lbAF">CONFIGURATION</A><DD>
|
|
<DT id="23"><A HREF="#lbAG">SERVICES</A><DD>
|
|
<DT id="24"><A HREF="#lbAH">REPORTING BUGS</A><DD>
|
|
<DT id="25"><A HREF="#lbAI">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:28 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|