realm

realm — Manage enrollment in realms

Synopsis

realm discover -v [realm-name]

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

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

realm list

realm permit [-a] [-R realm] {user} ...

realm deny [-a] [-R realm] {user} ...

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

Run in install mode. This makes realmd chroot into the specified directory and place files in appropriate locations for use during an installer. No packages will be installed or services will be started when running in this mode.

--verbose, -v

Display verbose diagnostics while doing running commands.

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:

--client-software=xxx

Only discover realms for which we can use the given client software. Possible values include sssd or winbind.

--server-software=xxx

Only discover realms for run the given server software. Possible values include active-directory or freeipa.

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 FreeIPA.

Unless a [--user] is explicitly specified, then if possible, an automatic join is attempted first.

The following options can be used:

--client-software=xxx

Only join realms for which we can use the given client software. Possible values include sssd or winbind. Not all values are supported for all realms. By default the client software is automatically selected.

--computer-ou=OU=xxx

The distinguished name of an organizational unit to create the computer account. The exact format of the distinguished name depends on the client software and membership software. You can usually omit the root DSE portion of distinguished name.

--membership-software=xxx

The software to use when joining to the realm. Possible values include samba or adcli. Not all values are supported for all realms. By default the membership software is automatically selected.

--one-time-password=xxxx

Perform the join using a one time password specified on the command line. This is not possible with all types of realms.

--server-software=xxx

Only join realms for run the given server software. Possible values include active-directory or freeipa.

--user

The user name to be used to authenticate with when joining the machine to the realm. You will be prompted for a password.

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

Only leave the realm which is using the given client software. Possible values include sssd or winbind.

--server-software=xxx

Only leave the realm which is using the given server software. Possible values include active-directory or freeipa.

--remove

Remove or disable computer account from the directory while leaving the realm. This will usually prompt for a pasword.

--user

The user name to be used to authenticate with when leaving the realm. You will be prompted for a password. Implies --remove.

List

List all the discovered and configured realms.

1
$ realm list

Permit

Permit local login by users of the realm.

$ realm permit -a
$ realm permit DOMAIN\User

If more than one realm is configured, then use the --realm option to specify which realm to permit the users on.

The format of the user name can be seen by using the list command.

The following options can be used:

--all, -a

Permit login by any valid user of the realm.

--realm, -R

Specify the name of the realm to permit users to log into.

Deny

Deny local login by users of the realm.

$ realm deny -a
$ realm deny DOMAIN\User

If more than one realm is configured, then use the --realm option to specify which realm to deny the users' login via.

The format of the user name can be seen by using the list command.

The following options can be used:

--all, -a

Deny login by any validuser of the realm.

--realm, -R

Specify the name of the realm to deny users login to.