NAME¶

realm - Manage enrollment in realms

SYNOPSIS¶

realm discover [realm-name]

realm join [-U user] [realm-name]

realm leave [-U user] [realm-name]

realm list

realm permit [-ax] [-R realm] {user@domain...}

realm deny -a [-R realm]

DESCRIPTION¶

realm is a command line tool that can be used to manage enrollment in kerberos realms, like Active Directory domains or IPA domains.

See the various sub commands below. The following global options can be used:

--install=/path

--unattended

--verbose, -v

DISCOVER¶

Discover a realm and its capabilities.

$ realm discover

$ realm discover domain.example.com

After discovering a realm, its name, type and capabilities are displayed.

If no domain is specified, then the domain assigned through DHCP is used as a default.

The following options can be used:

--all

--client-software=xxx

--server-software=xxx

--membership-software=xxx

JOIN¶

Configure the local machine for use with a realm.

$ realm join domain.example.com

$ realm join --user=admin --computer-ou=OU=Special domain.example.com

The realm is first discovered, as we would with the discover command. If no domain is specified, then the domain assigned through DHCP is used as a default.

After a successful join, the computer will be in a state where it is able to resolve remote user and group names from the realm. For kerberos realms, a computer account and host keytab is created.

Joining arbitrary kerberos realms is not supported. The realm must have a supported mechanism for joining from a client machine, such as Active Directory or IPA.

If the domain has been preconfigured, and unless --user is explicitly specified, an automatic join is attempted first.

Note that the --user, --no-password, and --one-time-password options are mutually exclusive. At most one of them can be specified.

It is generally possible to use kerberos credentials to perform a join operation. Use the kinit command to acquire credentials prior to starting the join. Do not specify the --user argument, the user will be selected automatically from the credential cache. The realm respects the KRB5_CCACHE environment variable, but uses the default kerberos credential cache if it's not present. Not all types of servers can be joined using kerberos credentials, some (like IPA) insist on prompting for a password.

The following options can be used:

--automatic-id-mapping=no

--user=xxx

--computer-ou=OU=xxx

--computer-name=xxx

--no-password

--one-time-password=xxxx

--client-software=xxx

--server-software=xxx

--membership-software=xxx

--user-principal=host/name@REALM

--os-name=xxx

--os-version=xxx

LEAVE¶

Deconfigure the local machine for use with a realm.

$ realm leave

$ realm leave domain.example.com

If no realm name is specified, then the first configured realm will be used.

The following options can be used:

--client-software=xxx

--server-software=xxx

--remove

--user

LIST¶

List all the discovered and configured realms.

$ realm list

By default, realms that have been discovered, but not configured (using the join command), are not displayed. Also, by default, the list of realm details displayed is verbose. The options below can be used to change this default behavior

The following options can be used:

--all

--name-only

PERMIT¶

Permit local login by users of the realm.

$ realm permit --all
$ realm permit user@example.com
$ realm permit DOMAIN\\User2
$ realm permit --withdraw user@example.com

The current login policy and format of the user names can be seen by using the realm list command.

The following options can be used:

--all, -a

--groups, -g

--realm, -R

--withdraw, -x

DENY¶

Deny local login by realm accounts.

$ realm deny --all

This command prevents realm accounts from logging into the local machine. Use realm permit to restrict logins to specific accounts.

The following options can be used:

--all, -a

--realm, -R

SEE ALSO¶

realmd.conf(5)

AUTHOR¶

Stef Walter <stef@thewalter.net>